XML评论部分类/方法

Question

是否有一种标准方法,用于生成API文档的工具处理部分类的XML样式注释？基本上,应该如何评论部分类/方法,以便生成的帮助文档不被破坏？这个问题可能因使用的工具而异,在这种情况下,我想最重要的两个工具是:

• Visual Studio的内置方法来创建XML文档
• 微软的Sandcastle

我不希望我的XML文档出来时髦

/// <summary>Some Foo class</summary>
public partial class Foo { ... }

/// <summary>Some Foo class that implements some interface.</summary>
public partial class Foo : ISomeInterface { ... }

Answer 1

最佳做法是仅为部分定义中的一个提供XML注释.不需要将1个班级的公众意见分成2个地方.

Visual Studio的工作方式是一个注释将覆盖另一个注释.(您可以通过使用不同的XML注释创建同一类的2个部分定义来确认这一点,然后创建此类型的变量.intellisense将仅显示1个XML注释.)

这也是使用Visual Studio生成的XML注释文件的任何文档工具的行为,其中包括Sandcastle.