是否有针对C#XML文档发布的风格指南？

我要求编写C代码的开发人员遵循StyleCop的指导原则。这对于代码来说很好，但我几乎总是对文档（好吧……好吧……所以没人问，因为程序员往往讨厌文档）风格有疑问。我可以建议复制MSDN的风格，但我很好奇微软或其他人是否发表过关于这方面的文章

例如，构造函数的文档记录如下

/// <summary>
/// Initializes a new instance of <c>MyClass</c> using the specified <c>BaseMyClass</c>.
/// </summary>
/// <param name="myParam">The <c>MyParam</c> of the current session.</param>

//
///使用指定的BaseMyClass初始化MyClass的新实例。
/// 
///当前会话的MyParam。

在这里，我不想引发关于如何编写文档的辩论。我正在寻找一些关于文档建议语法的公开指南

提前谢谢

StyleCop实际上也为XML文档提供了规则。如果你不遵循特定规则设置的模式，它会抱怨

这些都是SA1600-SA1647的规则

例如，规则SA1642:ConstructorSummaryDocumentation必须从标准文本开始，并声明：

非私有实例构造函数的摘要必须以“初始化{class name}类的新实例”开头

---

有关更多信息，请参见。

如果您想了解如何以及在何处使用XML文档的一般指南，以下是两个非常有用的链接（我已经多次提到过）

• （死亡-）

我猜这大概就是你要找的那种东西。关于XML注释的实际措辞和语法，我也搜索了关于这方面的建议/指南，但没有结果。在这方面，最好的办法就是简单地遵循.NETBCL（基类库）——尽管BCL文档中也存在奇怪的不一致性

希望有助于…

我的visual studio加载项将生成和更新XmlDoc注释

它有一组模板，允许您指定确切的样式（对于不同类型的代码元素，哪些条目是合法的，它们列出的顺序，某些条目之间是否有空行，以及封闭文档块的样式）。它将删除不再正确的条目（例如删除参数），并为未记录的功能添加条目（例如新参数或抛出的异常），并使用自动缩进和换行来保持文档整洁

因此，通过使用AU生成和更新注释，您可以非常轻松地为文档注释实施特定的样式和布局。如果您希望使用StyleCop强制执行某些文档规则，AtomineUrtils可以选择以StyleCop兼容的格式生成文档

---

它还使编写代码变得如此快速和简单，以至于即使是团队中不太愿意编写代码的程序员也更有可能编写好代码。

它是否概述了编写常量文档的指导原则？我在哪里可以找到它使用的文档规则列表（最好是纯文本格式）？常量和其他元素一样处理，所以SA1600、1602、1603、1604、1606、1607、1608规则都适用。谢谢，这正是我要找的。是的，我也是这样做的……我正在寻找语法和短语。显然，StyleCop的验证比我想象的要多，所以我来看看他们的规则。如果你没有使用GhostDoc，你可能也想试试它：它非常接近StyleCop的指导原则……StyleCop的指导原则就足够了。我只是想找一些可以发布给开发者的东西。不过，谢谢！