コメントの使い方

コメントアウトとは

C#スクリプトの中にはコメントを記載する事ができます。 コメントとはプログラムファイルに記載されている、プログラムとして動作しないテキストの部分 を指していて、そのプログラム内にある関数の挙動をメモしたり、値の役割をメモしたり、バグや今後実装する予定のメモだったりします。

単一行のコメント

1
// ここにコメントを記載します。

複数行のコメント

1
2
3
4
5
/*
ここにコメントを記載します 1行目。
ここにコメントを記載します 2行目。
ここにコメントを記載します 3行目。
*/

今後する事のメモ

1
2
3
4
/*
TODO:
この値を外から参照する関数を作る
*/

とか、

1
2
3
4
/*
FIXME:
引数が空の時にバグが発生するので直す事
*/

みたいにメモしておきます。

ドキュメントコメント

特定のルールに応じたタグ付けをしたコメントを入れておくと、エディタの補完に説明書きを入れたり、コンパイル時にドキュメントコメントをファイルに出力するなど、より高度な事ができるようになっています。

1
2
3
4
5
6
/// <summary>
/// テスト用のメソッド
/// </summary>
/// <param name="param1">引数1</param>
/// <param name="param2">引数2</param>
/// <returns>返す値</returns>