■コメント
コメントとは、プログラムを補足説明したり
修正履歴を残したりする目的で利用されます。
成果物である実行ファイルに何ら影響を与えないので
要所要所にコメントを付与しましょう。
使い方は自由です。
コメントを書く場所も、量も。
ですが、プログラムはあくまでもコードが主ですので、
その可読性を落とすようなコメントの書き方だけは避けましょう。
また、自分が作ったプログラムを他人が見ても意味が理解できるように
逆に自分でも自分が作ったプログラムについて時間が経過すると忘れてしまうものなので
将来の自分のためにもコメントは書きましょう。
C#には3種類のコメントがあります。
最初の2つはお馴染みのものです。
指定範囲コメント
/* からはじまり
*/ で終わる範囲をコメントとします。
/*
ここから
範囲コメント(CやC++と同じですね)
ここまで
*/
但し、↓のように入れ子のような使い方はできません。
/*
ここはコメントになります
/*
ここはコメントになります
*/
ここはコメントになりません!
*/
// から後ろ(行末まで)をコメントとします。
// 単一行のコメント(C++と同じですね)
int a = 10; // 任意の行の後ろに付けて、行末までコメント
XML形式のタグを埋め込むことで
後々、ドキュメント等を楽に作成することができそうです。
(関数の定義、概要、引数の説明、戻り値の意味、などなど)
これについての具体的な利用方法についてはまだ調べていませんが
こんな情報を見つけました。
C++にもdoxygenのようにコードからドキュメントを生成するものがあるように
普段からXML形式のタグでコメントを付与しておくと
後で楽ができるかもしれません。
/// <summary>
/// 関数の名称や概要
/// </summary>
/// <param name="1番目の変数名">説明1</param>
/// <param name="2番目の変数名">説明2</param>
以上で演算子についての説明を終わりますが
サンプルプログラムを変更して動きの違いを見てみたり
色々工夫してみてください。
Copyright © 2008.07 - shougo suzaki
|