23

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

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

我不希望我的 XML 文档变得时髦

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

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

1 回答 1

20

最佳实践是只为部分定义中的 1 个提供 XML 注释。应该没有必要将1 类的公共评论分成 2 个地方。（当然，在每个部分定义中都有常规注释仍然有意义。）

Visual Studio 的工作方式是一个部分定义中的注释将覆盖另一个。您可以通过创建具有不同 XML 注释的同一类的 2 个部分定义来确认这一点，然后创建此类型的变量。智能感知将仅显示 1 条 XML 注释。

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

于 2011-05-12T23:52:17.953 回答