<Summary>ってなに?
- 関数につけるコメント
- 関数の説明とか仕様とかを書き記せる
- 実はコメントと言いながらXMLドキュメント
- 関数の上にカーソルを当てると出てくる説明がこれ
とにもかくにも使ってみよう
/// <summary>
/// 名前を自動で出力
/// </summary>
/// <param name="param1">スタイルの指定(0:日本語 1:英語)</param>
/// <returns>成功ならtrue,失敗ならfalse</returns>
public bool PrintName(int param1) {
if (param1 == 0) {
Console.Write("山田太郎");
} else if (param1 == 1) {
Console.Write("Yamada Taro");
} else {
return false;
}
return true;
}
今回は関数の上に記述していますが、関数定義後でも大丈夫(だったはず)です。
VisualStudioで開発する場合はこのコメントを折りたたむようにしておけばコードリーディングの際に余分な行を隠せるので効率が良くなります。
ほかにもいろいろなタグが
Microsoftの公式にいろいろ載ってます。必要に応じて使ってください。