如何导出 C# / VisualStudio 2008 中的代码文档？

Question

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

今天我实际上必须这样做，但我不知道如何做。我有什么遗漏的吗？我想去 菜单->构建->构建代码文档, ，但是没有办法做到这一点。

Answer 1

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

之后您可以使用以下命令构建实际帮助 沙堡.

Answer 2

你可以尝试 国家发展委员会 或者 沙堡 如果您不介意使用第三方工具。

Answer 3

沙堡 非常适合生成文档，并且它支持多种不同的生成格式。据我所知，没有任何 Visual Studio 集成，但有一个 沙堡GUI 因为它是可用的。

Answer 4

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

Answer 5

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

Answer 6

原来的 NDoc 项目（其他人提到的）已经死了，但是有一个新项目叫做 NDoc3.

NDoc3 支持 .NET 2.0 - 3.5。它目前是测试版，对我来说效果很好。我不确定该项目是否仍然活跃 - 最后一个测试版于 2009 年 4 月发布。