.net net评论应该以大写字母开头，以句号结尾吗？

根据我得到的反馈，我可能会和同事们一起提高这个“标准”。这可能会成为一个自定义的StyleCop规则。已经写好了吗

因此，Stylecop已经为

summary

、

param

和

return

文档标记规定了这一点

你认为从评论中要求同样的东西有意义吗

相关提示：如果一条评论已经很长了，那么它应该被写成一个合适的句子吗

例如（也许我太过努力地试图说明一个不好的评论）：

vs

如果是这样的话——大多数时候，如果一个人费心写评论，那么它也可以提供信息。考虑这两个样本：

//if exception quit
if (exc != null)
{
    Application.Exit(-1);
}

及

可以说，一个根本不需要评论，但既然提供了一个，我认为第二个更好

请支持你的意见。对于评论艺术，特别是与.Net相关的评论艺术，您是否有很好的参考资料

---

谢谢。

花时间写清楚、可读、易懂的评论绝不是浪费。有多少次我在以后的某个日子里重读了自己的评论，却很难理解它们。写草率或格式不好的注释的人通常在代码中使用相同的特性。

如果代码需要注释，那么它应该是格式良好的，因为在我看来，可能有一个（非琐碎的）概念需要解释

---

应该避免像示例中那样的琐碎评论。它们只会增加噪音。

我经常写注释，这些注释只是为了帮助我找到代码部分。（我也为此使用了区域。）例如：

//服务器

由于IDE将注释着色，因此有时可以方便地使用类似这样的简短注释来帮助在思想上将内容划分为多个部分。我通常只对十几行代码执行此操作。如果更长，则

#区域

似乎更好

我也经常在我的评论中写笔记，有时作为我自己的参考：

/// <summary>
/// Populates the properties of a Sensor object based on
/// the XML components of its data file.
/// </summary>

---

//注意：-273.15是以°C为单位的绝对零，用于低于

这不是一个语法上优美或完整的句子，但它是有意义的

我倾向于使用更完整、结构化的句子的地方是我的方法总结，如下所示：

/// <summary>
/// Populates the properties of a Sensor object based on
/// the XML components of its data file.
/// </summary>

//
///基于以下内容填充传感器对象的属性：
///其数据文件的XML组件。
/// 

---

我觉得更容易被别人阅读，这有助于冗长和干净的格式。

< P>如果你在VisualStudio中注释方法，你应该考虑在方法的顶部使用摘要和PARAMS。这样，您就可以在代码完成期间获得有关该方法的详细信息。这里有一个例子

    /// <summary>
    /// you summary here
    /// </summary>
    /// <param name="param1">Describe parameter usage</param>
    /// <param name="param2">Describe parameter usage</param>

//
///你可以在这里总结一下
/// 
///描述参数用法
///描述参数用法

我发现，当我试图简短地发表评论（即不完整的句子、片段）时，我经常会遗漏一些关键的假设或实际上可以澄清意思的词语。对不起，我现在很难想出一个具体的例子

不过，总的来说，强迫自己写出完整、恰当的句子也会迫使你更多地思考自己在评论中真正想说什么。我经常发现自己在重新思考我真正想在评论中包含的内容，并将其全部写出来

---

没有充分的理由在简洁的祭坛上牺牲清晰度。将来需要有人理解代码。注释是为他们准备的，所以让他们更容易理解。

我个人会将这些类型的注释放在if中的代码块中，这样你就可以对else条件（如果存在）进行注释。引用OP“因此，Stylecop已经为summary、param和return documentation标记指定了这一点”…+1作为summary位，这很好。我的一些同事设置了Resharper删除所有“传统”评论。当然！只是alt+176。我在工作中经常遇到这个符号！：）注：-273.15是绝对零，单位为°C，用于以下最小值。-这几乎是一个恰当的句子，只需在它前面打一个“请”。这就是我想说的。是的，我可以看出“//Server”或“//constructor”是多么有用。我想问题又来了——如果一条评论已经很长了，那么它应该是一个合适的句子吗？我想我的官方答案应该是“不”，因为没有真正的理由，除非你对合适的英语（或其他）语言注释感到更舒服。没有语法警察会检查这些评论。这可能很重要的唯一原因是，如果您处于团队开发环境中，并且您的同事坚持要求您提高评论的可读性：是的，我处于团队环境中，我希望看到更好的评论：）

/// <summary>
/// Populates the properties of a Sensor object based on
/// the XML components of its data file.
/// </summary>

    /// <summary>
    /// you summary here
    /// </summary>
    /// <param name="param1">Describe parameter usage</param>
    /// <param name="param2">Describe parameter usage</param>