如何在C#/ Visual Studio 2008中导出代码文档?

时间:2008-09-09 12:53:48

标签: c# .net visual-studio-2008 xml-documentation

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

今天我实际上必须这样做,但我很难找到方法。有什么我想念的吗?我想去菜单 - >构建 - >构建代码文档,但没有选项可以做到这一点。

7 个答案:

答案 0 :(得分:24)

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

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

答案 1 :(得分:4)

如果您不介意使用第三方工具,可以尝试NDOCSandCastle

答案 2 :(得分:1)

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

答案 3 :(得分:1)

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

答案 4 :(得分:1)

迟到的评论,但值得补充一点,即使Sandcastle已被封存,Sandcastle Help File Builder仍在积极开发中,我发现在处理这种情况时非常强大而且直截了当 - 安装到富人。 chm和.html / .asp输出几个小时。

答案 5 :(得分:0)

最初的NDoc项目(其他人提到)已经死了,但有一个名为NDoc3的新项目。

NDoc3支持.NET 2.0 - 3.5。它目前作为测试版提供,对我来说非常有用。我不确定该项目是否仍然有效 - 最后一个测试版于2009年4月发布。

答案 6 :(得分:0)

以前的答案真的过时了。这里有一些更现代的选择:

  • DocFX:这可能是最好的选择,因为它可以在Linux,macOS和Windows上运行,并且受.NET Foundation支持。
  • Sandcastle Help File Builder (SHFB):此命令仍受支持,但可能不那么活跃。