1

我们有一个可以追溯到 ASP 时代的非常古老的应用程序,我们正在逐步将其重构为 ASP.NET + VB.NET 代码库。

它包含许多具有以下类型的文件:

aspx、asmx、ascx、vb、js (JavaScript)、html、vbs (VBScript)。

后端数据库是带有大量存储过程的 SQL Server 2005。

我们想创建一个从代码文件中的注释自动生成的代码文档。我非常喜欢 Doxygen,但似乎它不支持上述技术。您能否推荐一些文档生成器工具,最好是单个工具或一组工具?

非常感谢。

阿吉特。

4

3 回答 3

2

你可以看看微软的 Sandcastle工具。我已经多次使用它,它会根据您的 .NET 代码中提供的注释生成文档。如果我没记错的话,它还可以为 JavaScript 库生成文档。

于 2009-07-21T04:35:15.437 回答
0

我用过SandCastle,如果你的代码中有 xml 注释,它会很好用。

您首先通过在项目属性 -> 编译 -> 生成 XML 文档中设置来在项目中启用 xml 文档。

完成后,您可能必须将警告设置为错误,以便工作室可以向您指出丢失的位置和所有 XML 注释。

要添加 XML 注释,请将光标放在类定义或函数定义之前,然后键入

///

这将自动为文档生成 xml 标签,完成后,您可以导入项目并开始构建文档。

好的部分是,如果你已经很好地记录了你的类,当你在你的应用程序中使用这些函数时,你可以找到你写的描述,就像智能​​感知文档的工作方式一样。

如果您遇到任何其他问题,请告诉我。

我的最后一个建议是,创建一个 hello world 项目并将其 xml 文档化并习惯于使用它进行沙堡操作。

于 2009-07-21T04:55:44.787 回答
0

有一些在那里:

沙堡

国家发展委员会

于 2009-07-21T04:35:33.687 回答