如何在C#/ VisualStudio 2008中导出代码文档?
时间:2020-03-05 18:50:01 来源:igfitidea点击:
我一直强调使用Cxml语法为类和方法编写漂亮的代码注释。我一直希望以后可以轻松导出它们。
今天,我实际上必须这样做,但是很难找到方法。有什么我想念的吗?我想转到菜单->构建->构建代码文档,但是那里没有选择的选项。
解决方案
回答
如果我们不介意使用第三方工具,则可以尝试NDOC或者SandCastle。
回答
实际上是在项目属性中。在"构建"选项卡的"输出"部分中,选择XML文档文件,然后输入文件名。它将建立在项目的每个版本上。
之后,我们可以使用Sandcastle建立实际的帮助。
回答
Sandcastle在生成文档方面做得很好,并且支持几种不同的生成格式。据我所知,它没有任何Visual Studio集成,但是有适用于它的SandcastleGUI。
回答
如果我们正在使用LINQ to SQL,请当心,因为我们将无法轻松地向自动生成的对象添加可持续注释。
回答
最初的NDoc项目(已被其他人提及)已死,但是有一个名为NDoc3的新项目。
NDoc3支持.NET 2.0 3.5. 目前,它是beta版,对我来说效果很好。我不确定该项目是否仍在活动中,最新的Beta是在2009年4月发布的。