.NET Visual C#言語入門 > コメント

Top > .NET Visual C#言語入門 > コメント

コメントとは、プログラムの注釈のことで、人（制作者含む）へのメッセージです。コンパイル時には、コメントは無視されます。

プログラムは、１行１行の意味はわかっても、

• このメソッドの目的は何でどんな機能を提供するか、
• このクラスは、どんなことを提供使用としているのか、
• どんな背景があるのかという状況や制作者の思いを正確に理解するはできません。

他人が作ったプログラムはもちろんですが、自作プログラムでもコメントがなければ、正確にはわかりませんし、思い出すにも時間がかかってしまいます。

プログラムのコメントとして

• ソースコード全体の要約
• クラス、メソッドの目的と結果、機能・サービス、特記事項、変数の名称

    /*
     * クラス全体の説明を記述する
     */
public class TemplateClass
    {
        #region 　クラスの実装
        // クラスの実装

#region 　フィールド（クラス内のグローバル変数）
        // クラス内のグローバル変数の宣言・定義
        // クラス内で使用されるデータ構造も含まれる
        // （public宣言は行わない。外部から変更する必要がある場合はプロパティ
        //  など間接的な方法で実装する）
        #endregion

        #region 　コンストラクタ・デストラクタ
        // コンストラクタ・デストラクタを実装
        #endregion

        #region 　公開メンバ（プロパティ・メソッド）
        // 外部との窓口になる
        #endregion

        #region 　内部（非公開）メンバ（プロパティ・メソッド）
        // 非公開のメンバを記述する
        #endregion

        #endregion
    }

プログラミング・テクニック

• 処理を箇条書きすることをおすすめします。
  文章で処理を書いて検証することで、プログラミングの作業負担を最小限に。
• 後でコメントを書く場合、思い出すのに手間も時間もかかりますから、プログラミングしながらコメントを書くという習慣を身につけましょう。