c# - C# コメントのチュートリアル

Question

「 C# コメント」について、学生に配布できる最高の資料はどれか知りたいです。

Answer 1

少し前に読んだ（そしてどこにあるのか分からなくなった）ものは次のとおりです。

• 初心者コメントなし
• 見習いは明らかなことをコメントします
• その理由を旅人が語る
• マスターは、別の方法でそれを行わない理由をコメントします

Answer 2

ブログCoding Horrorの Jeff Atwood によるこの投稿では、一般的なコメントの目的について説明しています。「当たり前」と思うかもしれないことは、実際にはそうではありません。特に「現実の世界」では、以下のようなコメントが表示されます。

//Connect to the Database
Db.Connect();

そしてもちろん、その投稿には当然の帰結があります: Coding Without Commentsです。

Answer 3

インサイドVS

コメントは比較的簡単です。

単一行に使用できます：

//This is a single line comment

複数行に使用できます：

/*
Multiple lines
*/

メソッドには、次を使用できます。

    /// <summary>
    /// This is a description
    /// </summary>
    /// <param name="sender">Description of variable SENDER</param>
    /// <param name="e">Description of variable E</param>

外VS

Project プロパティに移動すると、すべてのコメントを XML に出力して操作できます。

いい練習

コードが何をするのかを説明するためにコメントを使用するべきではありません。

Answer 4

これは、xml コメントで行うのが非常に興味深いです: http://thoughtpad.net/alan-dean/cs-xml-documentation.html

これらもサンドキャッスルによって読み取られます... :o)