用于生成 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 { ... }