ソースコードにコメントはあまり書きたくないが、書くとコードの理解の助けになる場合もあるという事は理解している。従って、コメントは必要最小限にしておきたい。不要、余計、過剰なコメントは癌だ。
C# や Visual Basic は「XML ドキュメントコメント」があるが、これがディ・モールト鬱陶しい。好き嫌いシリーズ - コード書法 に通じるが、XML ドキュメントコメントは一度に目に入るコード量を減らす。めったにドキュメント化しないのに必要か? そして律儀に XML ドキュメントタグをつける人に限って肝心の中身がなかったりする。
/// <summary>
///
/// </summary>
/// <param name="hoge"></param>
/// <param name="fuga"></param>
/// <returns></returns>
public int Hoge(int hoge, string fuga)
何がしたいんだ?