【发布时间】：2011-02-19 21:28:57
【问题描述】：
有没有办法在 visual-c++ 项目中获取文档（如 javadoc）？
我正在使用 Visual Studio 2010。
谢谢！
【问题讨论】：
标签： c++ visual-studio visual-c++ documentation
【发布时间】：2011-02-19 21:28:57
【问题描述】：
您也可以使用 VS2010 支持的 XML-Documentation 格式。 http://msdn.microsoft.com/en-us/library/ms177226%28VS.80%29.aspx
注释您的代码后，您可以使用 Sandcastle 创建类似 MSDN 的文档：http://sandcastle.codeplex.com/。 （这里是 Sandcastle 的 GUI 表示，它更容易使用：https://github.com/EWSoftware/SHFB）
我使用 AtomineerUtils 自动创建 XML-Documentation 标头。这个工具会给你很多帮助。您可以在这里获得免费的基础版本：http://www.atomineerutils.com/products.php
【讨论】：
-
+1 -- 这不仅会生成漂亮的文档，编译器还会使用类型和 cmets 所附加的类型以及各种其他好东西来注释输出。如果您需要跨平台故障转移，Doxygen 也可以识别这种格式。
-
我无法为 C++ 项目解决这个问题，我发现：提供对非托管 C++ (sandcastle.codeplex.com/workitem/3855) 的支持和使用 C/C++ 项目的示例？ （shfb.codeplex.com/discussions/217100）。那么原生 C++ 真的可以使用 Sandcastle 吗？
-
GhostDoc 和 CppTripleSlash 是自动创建 xml 文档标头的其他替代方法
你可以看看Doxygen。
【讨论】：
-
我不得不说我对 Doxygen 没有印象。即使是现在（2017 年），似乎也无法生成自动包含参数类型的参数文档，而您认为这是一个非常基本的要求。
-
那是 C++ 顺便说一句。
您可以使用我的插件 Atomineer Pro Documentation 快速生成 Documentation-XML、Doxygen、Qt 或 JavaDoc 格式的文档 cmets。然后使用 Sandcastle (DocXml) 或 Doxygen (DocXml, Doxygen, Qt, Javadoc) 将此文档转换为外部文档文件。
我建议使用 DocXml 格式，因为上述所有工具都可以使用它，并且 Visual Studio 可以识别它（它会对其语法着色，并将文档构建到其智能感知数据库中，因此它会在您键入时出现在工具提示帮助中类/方法名称添加到您的代码中）。
【讨论】：
另外，看看CppTripleSlash - xml doc comments for c++。它是一个免费的 Visual Studio 2015、2013、2012、2010 扩展。
【讨论】：
生成文档的一种方法是 - 你猜对了 - javadoc。您只需像平常一样进行注释，javadoc 可以很好地将它们转换为 HTML/LaTeX 样式。
当然，这不是唯一的解决方案。我会给别人留点空间。
【讨论】：
-
嗯.. Java 和 C++ 很相似，但它们并没有那么相似。当Javadoc在源代码中遇到模板之类的东西时，它不会知道该怎么做。
-
@Billy：不过，您可以在 Doxygen 中使用 Javadoc 样式的 cmets。
如果您使用的是 Visual Studio 2015，那么有一个为宏浏览器扩展编写的 Doxygen 生成器，它使用 JavaScript 作为宏语言。
项目在 github 上：https://github.com/cppocl/visual_studio_macros
【讨论】：
如果您不介意一些手写文档，那么 sphinx 是完美的工具。
http://www.sphinx-doc.org/en/stable/
这是一个例子：
sphinx-build -b singlehtml doc/ build/
【讨论】：