ASP.NET + VB.NET应用程序的代码文档

时间:2009-07-21 03:43:26

标签: documentation-generation

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

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

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

后端数据库是带有大量sprocs的SQL Server 2005。

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

非常感谢。

阿吉特。

3 个答案:

答案 0 :(得分:2)

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

答案 1 :(得分:0)

那里有一些:

SandCastle

NDOC

答案 2 :(得分:0)

我使用了SandCastle,如果你的代码中有xml注释,那就太好了。

首先在项目属性中设置xml文档 - >编译 - >生成XML文档。

完成后,您可能必须将处理警告设置为错误,以便工作室可以指出您缺少哪些XML注释和所有XML注释。

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

///

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

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

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

我的最后一个建议是,制作一个hello world项目和xml文档,并习惯用它来沙堡。