Visual Studio c ++文档生成器

Question

有没有办法在visual-c ++项目中获取文档（比如javadoc）？

我正在使用visual studio 2010。

谢谢！

Answer 1

您也可以使用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

Answer 2

您可以查看Doxygen。

Answer 3

您可以使用我的插件Atomineer Pro Documentation快速生成Documentation-XML，Doxygen，Qt或JavaDoc格式的文档注释。然后使用Sandcastle（DocXml）或Doxygen（DocXml，Doxygen，Qt，Javadoc）将此文档转换为外部文档文件。

我推荐使用DocXml格式，因为以上所有工具都可以使用它，并且Visual Studio会识别它（它的语法对其进行着色，并将文档构建到其智能感知数据库中，因此当您键入时它会出现在工具提示帮助中类/方法名称到您的代码中。）

Answer 4

另外，请查看CppTripleSlash - xml doc comments for c++。它是免费的Visual Studio 2015,2013,2012,2010扩展。

Answer 5

生成文档的一种方法是 - 你猜对了 - javadoc 。您只需按照通常的方式进行注释，javadoc就可以很好地将它们转换为HTML / LaTeX风格。

当然，这不是唯一的解决方案。我会给别人留下空间。

Answer 6

如果您使用的是Visual Studio 2015，则会为宏浏览器扩展编写一个Doxygen生成器，它使用JavaScript作为宏语言。

项目在github上：https://github.com/cppocl/visual_studio_macros

Answer 7

如果你不介意，一些手写文档，那么狮身人面像是完美的工具。

http://www.sphinx-doc.org/en/stable/

以下是示例：

http://ceres-solver.org/

sphinx-build -b singlehtml doc/ build/