C＃评论教程

Question

我想知道哪一个是我可以向学生提供的关于“ C＃comments ”的最佳资料。

Answer 1

Jeff Atwood在他的博客This Post上的

Coding Horror进入了一般评论的目的。你可能会认为“呃”真的不是 - 特别是在'现实世界'中，你会看到如下所示的评论：

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

当然，这篇文章有必然结果：Coding Without Comments。

Answer 2

我刚才读过的东西（并且已经忘记了去哪里）是：

• 初学者没有评论
• 学徒评论显而易见的
• 旅程者评论这样做的原因
• 大师评论不采取其他方式的原因

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外

当您进入项目属性时，您可以将所有注释输出到XML并对其进行操作。

良好做法

不应该使用注释来描述代码的作用，但是如果不清楚则为什么或如何。

Answer 4

这对xml注释非常有趣：http://thoughtpad.net/alan-dean/cs-xml-documentation.html

这些也由sandcastle阅读......：o）