なぜルールが必要なのか？
実際に開発をはじめる前にルールを決めておくことをおすすめします。
ルールを作成し ないまま開発を進めると、以下のような弊害が発生します。
可読性の低下
統一されたルールがないと、各開発者が異なるスタイルで実装をすることになります。
ほかの開発者がメンテナンスするときに開発の意図やアプリケーション構造を理解するのが難しくなるため、メンテナンスやレビューの効率が低下する可能性が高くなります。
バグの増加
一貫性のない変数構造や実装は、バグが見つけにくくなります。
異なるスタイルの実装方法が混在することで、意図しない動作が発生する可能性が高くなります。変数構造やアクションに対する役割・配置について意味を持たせることで、これらのリスクを低減できます。
チームの生産性の低下
実装方法の違いが原因で、成果物の理解や修正に時間がかかり、チーム全体の生産性が低下する可能性が高くなります。
教育と指導の難しさ
新人の開発者やプロジェクト新規参加メンバーを教育する際に、統一されたコーディングルールがないと、適切な指導が難しくなります。
ルールが定まっていない状態で開発をすると、メンテナンスコストが増加してしまい結果的に全体コストが高くなってしまう可能性があります。初めての開発や小規模開発の場合は最初に導入をしないケースが多いですが、可能であれば事前にルールを定めておきましょう。
以降のページでは、以下を前提に説明しています。
- Accel Studioを使って、アプリケーション単位に画面やロジックを作成・管理する
- アプ リケーションや機能を識別するため、IDと名称を命名・入力する
IDと名称の定義が適切でないとどこで困る？
Accel Studioで既存のロジックフローをリソースに追加したり、IM-BloomMakerのアクションエディタでフロールーティングを検索したりする場合、以下のような一覧画面で項目が表示されます。
このときに適切にIDや名称を定義していないと、機能を効率よく探すことが難しくなります。
Accel Studioで既存のリソースを追加する場合
IM-BloomMakerのデザイン画面でアクションを検索する場合