9

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

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

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

4

2 回答 2

9

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

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

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

于 2009-12-20T09:33:18.523 回答
1

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

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

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

于 2009-12-20T20:16:19.690 回答