[C#] コメント

こんにちは。明月です。
前の投稿でプログラムの基本構造について勉強しました。そう見るとアセンブラーよりは読みやすいですが、人間が読みやすいには言えません。
簡単なプログラムなら解読するのが大変ではないけど、複雑度が上がるとコードを読むのがだんだん大変になると思いますね。

それでプログラムをコーディング式ではなく、人が読みやすい方法でコメントがあります。
プログラム中でコメントを付ける方法は３つがあります。

改行タイプのコメントです。使用方法は改行頭に「//」を付けて使います。

//コメント例です。

次はブロックタイプのコメントがあります。使用方法は下記とおりです。

/* コメント例です。 これはブロックタイプでございます。 */

ブロックタイプのコメントは重複処理ができないので、使用するときに注意が必要です。

/* コメント例です。 これはブロックタイプでございます。 /* コメント重複*/ //エラーになります。 */

最後にXMLコメントがあります。XMLコメントはプロジェクトが終了する時にXMLコメントでマニュアルを生成できるコメントです。Javaの場合はJavadocと同じコメントです。
(でも実際にXMLコメントでマニュアルまで生成しません。機能としてはありますが…)

使用方法はClass頭あるいはMethod頭で「///」を付けて使います。

namespace commentEx { ///<summary> /// XMLコメント /// </summary> class Program { /// <summary> /// Mainメソッド /// </summary> /// <param name="args">パラメータ</param> static void Main(string[] args) { } } }

XMLコメントの場合各タグがあって、タグ別で説明する区切りがあります。下記の表を参考してください。

XMLコメントタグ	説明
summary	形式あるいは形式メンバ設定
remarks	詳細な説明
para	remarksの追加説明
value	プロパティの説明
example	使用例
list	リストとテーブル生成
code	何行目のコードで表示する時に使用
see	テキスト内部のリンク指定
seealso	参考部分に表せるテキスト指定
exception	例外説明
permision	接近権限説明
param	メソッドのパラメター説明
return	返却値を説明
c	説明中で含めているコード

プロジェクトを進める時に簡単なプログラムは一人で作成できますが、普通のプロジェクトならチームを組んで進めると思います。その時にメンバ間にコミュニケーションが合わないとプロジェクトがうまく進めると思わないですね。
また、プロジェクトが完了できて、数月を過ぎて後にバージョンアップがあることやバグが発生してメンテが必要な時にソース内容を覚えると問題がないですが、逆に仕様を忘れてしまうケースがありますね。
そのためにXMLコメントを利用してプロジェクトあるいはクラス、メソッドの説明を書いておいて、コミュニケーション、メンテ、仕様整理する時に利用すると良いと思います。

XMLコメント以外に改行コメント、ブロックコメントはC#ではなく、C言語、Javaにも同じ形式で使えますね。コメントはプログラムの勉強を始まる時に学ぶ重要な部分なのでちゃんと覚えていきましょう。