20

我一直很重视使用 C# xml 语法为类和方法编写漂亮的代码注释。我一直希望以后能够轻松地导出它们。

今天我实际上必须这样做，但我很难找出方法。有什么我想念的吗？我想去Menu->Build->Build Code Documentation，但是那里没有选择。

4

7 回答 7

27

实际上它在项目属性中。构建选项卡，输出部分，XML 文档文件，然后输入文件名。它将建立在项目的每个构建上。

之后，您可以使用Sandcastle构建实际帮助。

于 2008-09-09T12:57:06.873 回答
4

如果您不介意使用 3rd 方工具，您可以尝试NDOC或SandCastle 。

于 2008-09-09T12:56:19.217 回答
1

Sandcastle非常适合生成文档，它支持几种不同的生成格式。据我所知，它没有任何 Visual Studio 集成，但有一个可用的SandcastleGUI。

于 2008-09-09T13:00:23.450 回答
1

如果您使用的是 LINQ to SQL，请小心，因为您将无法轻松地将可持续的注释添加到自动生成的对象中。

于 2008-09-09T13:56:37.713 回答
1

迟到的评论，但值得补充的是，即使 Sandcastle 已被封存，Sandcastle 帮助文件生成器仍在积极开发中，我发现在处理这种情况时它非常强大且直接 - 安装到丰富的 .chm 和 .html /.asp 几个小时后输出。

于 2014-04-02T16:49:28.010 回答
1

以前的答案确实过时了。以下是一些更现代的选择：

  • DocFX：这可能是您最好的选择，因为它可以在 Linux、macOS 和 Windows 上运行，并且受到 .NET 基金会的支持。
  • Sandcastle Help File Builder (SHFB)：这个仍然受支持，但它可能不那么活跃。
于 2019-06-18T17:56:43.347 回答
0

最初的 NDoc 项目（其他人提到）已经死了，但是有一个名为NDoc3的新项目。

NDoc3 支持 .NET 2.0 - 3.5。它目前作为测试版提供，对我来说效果很好。我不确定该项目是否仍然有效——最后一个测试版是在 2009 年 4 月发布的。

于 2009-10-23T13:31:12.633 回答