トップ回答者
Visual Studio 2012 C# のコメント入力について

質問
-
回答
-
ひらぽんさんが既に答えられているようにできません。
そもそもメソッドの利用者がメソッド内の細かなコメントを読まなければならないとしたら、それはメソッドの設計が間違っていると思います。
それ以前に、メソッド内に細かなコメントを書くことも間違っていると思います。メソッド内には、why(なぜこのような処理を行うのか)、how(どのような手順で処理を行うのか)と大きなブロック単位でコメントを残すべきです。
その上で、メソッド外にwhat(メソッド全体で何を行うのか)を書くべきです。そしてこのwhatこそがXMLコメントに書き出され、メソッド利用者が読むべき内容です。- 回答としてマーク mitoh 2013年2月15日 0:09
すべての返信
-
> クラスやメソッドの中のコメントには適用できないのでしょうか?
残念ながらできません。またXML ドキュメントコメントの性質上、実装にコメントしても意味がないよう思われます。戻り値等は <returns> タグに含めればいいのではないでしょうか。
ドキュメント コメント用の推奨タグ (C# プログラミング ガイド)
ひらぽん http://d.hatena.ne.jp/hilapon/
- 編集済み ひらぽんModerator 2013年2月14日 9:46
-
ひらぽんさんが既に答えられているようにできません。
そもそもメソッドの利用者がメソッド内の細かなコメントを読まなければならないとしたら、それはメソッドの設計が間違っていると思います。
それ以前に、メソッド内に細かなコメントを書くことも間違っていると思います。メソッド内には、why(なぜこのような処理を行うのか)、how(どのような手順で処理を行うのか)と大きなブロック単位でコメントを残すべきです。
その上で、メソッド外にwhat(メソッド全体で何を行うのか)を書くべきです。そしてこのwhatこそがXMLコメントに書き出され、メソッド利用者が読むべき内容です。- 回答としてマーク mitoh 2013年2月15日 0:09