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

Question

21

我一直都养成用C#的xml语法写好类和方法注释的习惯，因为我一直期望能够轻松地将它们导出。

今天我需要导出注释，但是我无法找到方法。我应该怎么做呢？我想在“菜单-生成-生成代码文档”中进行操作，但是那里没有这个选项。

- Daren Thomas

OP已增加了这些建议：此链接提供了一个简单的XSLT，用于快速和脏的导出：http://www.codeproject.com/KB/XML/XMLDocStylesheet.aspx - Mogsdad

7个回答

4

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

- Gulzar

1

之前的回答已经过时了。以下是一些更现代化的选择：

- Brent Matzelle

1

晚了一步，但还是值得补充的是，尽管Sandcastle已经被搁置，但Sandcastle Help File Builder仍在积极开发中。我发现它非常强大且易于理解，可以在几个小时内安装并生成富有内容的.chm和.html/.asp文件。

- downwitch

1

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

- Rob

1

如果您正在使用 LINQ to SQL，请注意，您将无法轻松地向自动生成的对象添加可持续的注释。

- Khaaaan

0

原始的 NDoc 项目（其他人提到过）已经停止了，但是现在有一个新项目叫做NDoc3。

NDoc3 支持 .NET 2.0 - 3.5。它目前作为 beta 版本可用，并且对我来说非常好用。我不确定该项目是否仍然活跃 - 最后一个 beta 版本是在 2009 年 4 月发布的。

- M4N

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Biri · Accepted Answer

实际上这在项目属性中。转到“生成”选项卡，输出部分，输入XML文档文件名称。每次构建项目时都将构建它。

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