Visual Studio是否可以选择为Javadoc样式的注释生成html文档?

问题描述 投票:7回答:2

Visual Studio是否可以选择为Javadoc样式的注释生成html文档?如果是这样,完成此任务需要哪些步骤?

在BlueJ中,有一个选项可以将Javadoc样式的注释转换为html文件。

如下图所示,使用BlueJ的Java我想用Visual Studio做同样的事情:http://www.time-tripper.com/uipatterns/Patterns/Titled_Sections/javadoc.gif (来源:time-tripper.com

visual-studio visual-studio-2005 javadoc documentation-generation
2个回答
8
投票

你真的是指Java中的JavaDoc吗?如果是这样,我不相信 - 只需使用javadoc本身。 Visual Studio并不真正支持Java。

如果您的意思是C#XML文档注释,那么您可以更改项目属性以构建XML文件,然后使用NDoc(已停止)或Sandcastle来构建HTML(或chm等)。诚然,它并不像它可能那么容易。

编辑:如果你正在使用C ++,你应该看看Doxygen。可能有Visual Studio插件,但您可能最好只运行Doxygen作为构建过程的一部分。如果您使用的是C ++ / CLI,可能会有一些相当于C#XML的注释,但我不知道。


0
投票

您可以使用兼容Javadoc的注释样式,手动输入注释,或使用我的addin,Atomineer Pro Documentation来完成大部分工作。然后要生成外部文档,请使用doxygen,它快乐地读取javadoc。

另一种方法是(如Jon所说)使用XmlDoc格式注释,可以由Visual Studio(用于智能感知工具提示),Atomineer,Sandcastle和Doxygen使用。它是一种人性化程度较低的格式,但在Visual Studio环境中为您提供了显着的优势,因此它更灵活一些。

这两种方法都适用于C#,C ++,C(尽管C#在智能感知方面效果更好)

© www.soinside.com 2019 - 2024. All rights reserved.