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

【问题标题】：Does Visual Studio have an option to generate html documentation for Javadoc-style comments?Visual Studio 是否可以选择为 Javadoc 样式的注释生成 html 文档？
【发布时间】：2010-12-28 11:11:38
【问题描述】：

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

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

如下图所示，使用 BlueJ 的 Java 我想对 Visual Studio 做同样的事情：
_{（来源：time-tripper.com）}

【问题讨论】：

您能详细说明您要完成的工作吗？
@Alon 我在 Visual Studio 中使用 C++。

标签： visual-studio visual-studio-2005 javadoc documentation-generation

【解决方案1】：

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

如果您的意思是 C# XML 文档 cmets，那么您可以更改项目属性以构建 XML 文件，然后使用 NDoc（已停产）或 Sandcastle 构建 HTML（或 chm 等）。诚然，这并不容易。

编辑：如果您使用 C++，您可能应该查看Doxygen。可能有 Visual Studio 插件，但你最好只在构建过程中运行 Doxygen。如果您使用的是 C++/CLI，则可能有一些 C# XML cmets 等价物，但我不知道。

【讨论】：

对于 Sandcastle，我发现使用起来很糟糕。生成文档实际上需要七个复杂的步骤。但是有一个项目（我现在记不起名字了，谷歌会知道的）它围绕一个 GUI 构建 SandCastle 并使它变得漂亮且易于使用。您也可以将其插入构建过程的一部分
赞成你的回答，我会删除我的。我误解了这个问题。 :)
可能是 Sandcastle 帮助文件生成器：codeplex.com/SHFB ... 它似乎是 Sandcastle 的前端。
正如 Chris 所说，Sandcastle Help File Builder 使文档的生成变得非常容易。

【解决方案2】：

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

另一种方法是（正如 Jon 所说）使用 XmlDoc 格式的 cmets，Visual Studio（用于智能感知工具提示）、Atomineer、Sandcastle 和 Doxygen 都可以使用它。这是一种人类可读性较差的格式，但在 Visual Studio 环境中具有显着优势，因此更加灵活。

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

【讨论】：