标签 c# .net documentation
<分区>
我要求编写 C# 代码的开发人员遵循 StyleCop 的指导方针。它非常适合代码，但我几乎总是对文档(好吧……好吧……所以没人问，因为程序员往往讨厌文档)风格有疑问。我可以建议复制 MSDN 的风格，但我很好奇 Microsoft 或其他人是否发布了有关此的内容。
例如，构造函数记录如下。
/// <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>
我不想在这里引发关于应该如何编写文档的争论。我正在寻找某种关于文档建议语法的已发布指南。
提前致谢!
最佳答案
时尚警察 FxCop实际上也为 XML 文档提供了规则。如果您不遵循一组特定规则设置的模式，它会提示。
这些都是 SA1600-SA1647 的规则。
例如，规则 SA1642:ConstructorSummaryDocumentationMustBeginWithStandardText 指出:
The summary for a non-private instance constructor must begin with “Initializes a new instance of the {class name} class.”
有关详细信息，请参阅 FxCop .
关于c# - 是否有针对 C# XML 文档的已发布样式指南？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/2030288/