是否已发布C#XML文档的样式指南？

Question

我要求编写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>

在这里,我不是要引发关于如何编写文档的争论.我正在寻找一些关于文档建议语法的已发布指南.

提前致谢!

Answer 1

StyleCop FxCop实际上也提供了XML文档的规则.如果您不遵循由某组规则设置的模式,它会抱怨.

这些都是规则SA1600-SA1647.

例如,规则SA1642:ConstructorSummaryDocumentationMustBeginWithStandardText声明:

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

有关更多信息,请参阅FxCop.