はじめに
記述したコードで、コンパイラと、コードの読み取りが必要な場合がある他の開発者の両方に、自分の意図を伝える必要があります。 また、自分自身も自分のコードを最も頻繁に読む開発者であり、最初にコードを記述してから何か月も経っているため、明確で理解しやすいコードを記述するのが得策です。 コードを記述するのは 1 回かもしれませんが、何度も読む必要があることを忘れないでください。
別の開発者グループのコードを記述するように求められたとします。 あなたは彼らに会って仕様について話し合い、割り当ては明確です。 会議の後、開発中は独立して作業することになると言われました。 完了したら、コードを他のグループに渡します。 コーディング タスクが自分のスキル レベルを超えるわけではありませんが、他の誰かが保守するコードを記述する必要はまったくありませんでした。 チームからは、C# の標準的なコーディング規則に従う限り、問題はないはずだと言われました。 作業するコードに関連する C# コーディング規則を確認する計画を立てています。
このモジュールでは、変数の目的と意図が説明されている名前を選ぶ方法について学習します。 コードの大まかな要件とアプローチを文書化するコード コメントを追加する方法と、コード行を無視するようにコンパイラに一時的に指示する方法について学習します。 最後に、個々のコード行の関係を伝えるのに役立つ空白文字の使用方法について学習します。
このモジュールを終えると、コンパイラと他の開発者の両方に伝達するためのコードの読みやすさと品質を重視して、コードをより意図的に記述できるようになります。
重要
このモジュールには、Visual Studio Code を必要とするコーディング アクティビティが含まれます。 Visual Studio Code がインストールされ、C# アプリケーション開発用に構成されている開発環境にアクセスする必要があります。
学習の目的
このモジュールでは、次のことを行います。
- 変数に目的と意図が説明されているわかりやすい名前を選択する。
- コード コメントを使用して、コード行を無視するようコンパイラに一時的に指示する。
- コード コメントを使用して、コードの記述に関する上位レベルの要件または目的を説明する。
- 空白文字を効果的に使用してコード行の関係を伝えるコードを記述する。
前提条件
- Visual Studio Code を使って C# のコンソール アプリケーションを作成して実行した経験。
Console.WriteLine()を使ってコンソールにメッセージを出力した経験。ifとelse ifステートメントを使ってコード ブランチを作成した経験。