c# - C# 注释教程

Question

我想知道哪一个是我可以分发给我的学生的关于“ C# 注释”的最佳材料。

Answer 1

我不久前读过的东西（并且已经忘记了在哪里）是：

• 初学者不评论
• 学徒评论显而易见
• 熟练工评论这样做的原因
• 大师们评论不这样做的原因

Answer 2

Jeff Atwood 在他的博客Coding Horror上发表的这篇文章总体上是为了评论的目的。您可能认为“duh”的东西实际上并非如此——尤其是在“现实世界”中，当您看到如下评论时：

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

当然，还有那篇文章的推论：没有评论的编码。

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

这些也被沙堡阅读......：o）