blocks|key|1218339|text|您也可以使用VS2010支持的XML-Documentation格式。http://msdn.microsoft.com/en-us/library/ms177226%2528VS.80%2529.aspx|type|unstyled|depth|inlineStyleRanges|offset|length|style|BOLD|entityRanges|data|1218340|在注释代码之后，您可以使用MSDN来创建一个类似的文档：http://sandcastle.codeplex.com/。(这里是Sandcastle的图形用户界面表示，它更容易使用：https://github.com/EWSoftware/SHFB)|1218341|我使用AtomineerUtils自动创建XML文档头。这个工具会给你很大的帮助。你可以在这里获得免费的基础版本：http://www.atomineerutils.com/products.php|1218342|entityMap|0|LINK|mutability|MUTABLE|url|http://msdn.microsoft.com/en-us/library/ms177226%2528VS.80%2529.aspx|1|http://sandcastle.codeplex.com/|2|https://github.com/EWSoftware/SHFB|3|http://www.atomineerutils.com/products.php^0|F|H|Z|1S|0|0|O|2U|S|V|1|2J|Y|2|0|0|2R|1L|16|3|0^^$0|@$1|2|3|4|5|6|7|X|8|@$9|Y|A|Z|B|C]]|D|@$9|10|A|11|1|12]]|E|$]]|$1|F|3|G|5|6|7|13|8|@$9|14|A|15|B|C]]|D|@$9|16|A|17|1|18]|$9|19|A|1A|1|1B]]|E|$]]|$1|H|3|I|5|6|7|1C|8|@$9|1D|A|1E|B|C]]|D|@$9|1F|A|1G|1|1H]]|E|$]]|$1|J|3|-4|5|6|7|1I|8|@]|D|@]|E|$]]]|K|$L|$5|M|N|O|E|$P|Q]]|R|$5|M|N|O|E|$P|S]]|T|$5|M|N|O|E|$P|U]]|V|$5|M|N|O|E|$P|W]]]]

You could use the XML-Documentation format, supported by VS2010, too. <a href="http://msdn.microsoft.com/en-us/library/ms177226%28VS.80%29.aspx" rel="noreferrer">http://msdn.microsoft.com/en-us/library/ms177226%28VS.80%29.aspx</a> 

After commenting your code, you can use Sandcastle to create a MSDN-like documentation: <a href="http://sandcastle.codeplex.com/" rel="noreferrer">http://sandcastle.codeplex.com/</a>. (Here is a GUI representation for Sandcastle, which is a lot easier to use: <a href="https://github.com/EWSoftware/SHFB" rel="noreferrer">https://github.com/EWSoftware/SHFB</a>)

I use AtomineerUtils to create the XML-Documentation headers automatically. This tool will help you a lot. You can have free base version here: <a href="http://www.atomineerutils.com/products.php" rel="noreferrer">http://www.atomineerutils.com/products.php</a>

blocks|key|3312355|text|你可以看看Doxygen。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|3312356|entityMap|0|LINK|mutability|MUTABLE|url|http://www.doxygen.nl/^0|5|7|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

You can have a look at <a href="http://www.doxygen.nl/" rel="nofollow noreferrer">Doxygen</a>.

blocks|key|3312404|text|您可以使用我的插件Atomineer+Pro+Documentation快速生成文档格式的文档注释-XML、Doxygen、Qt或JavaDoc格式。然后使用沙堡(DocXml)或DocXml+(DocXml，DocXml，Qt，Javadoc)将此文档转换为外部文档文件。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|3312405|我建议使用DocXml格式，因为上面的所有工具都可以使用它，并且Visual+Studio可以识别它(它会对它进行语法着色，并将文档构建到它的智能感知数据库中，这样当你在代码中键入类/方法名称时，它就会出现在工具提示帮助中)。|3312406|entityMap|0|LINK|mutability|MUTABLE|url|http://www.atomineerutils.com/^0|9|R|0|0|0^^$0|@$1|2|3|4|5|6|7|N|8|@]|9|@$A|O|B|P|1|Q]]|C|$]]|$1|D|3|E|5|6|7|R|8|@]|9|@]|C|$]]|$1|F|3|-4|5|6|7|S|8|@]|9|@]|C|$]]]|G|$H|$5|I|J|K|C|$L|M]]]]

You could use my addin, <a href="http://www.atomineerutils.com/" rel="nofollow noreferrer">Atomineer Pro Documentation</a> to quickly generate documentation comments in Documentation-XML, Doxygen, Qt or JavaDoc format. Then use Sandcastle (DocXml) or Doxygen (DocXml, Doxygen, Qt, Javadoc) to convert this documentation into external documentation files.

I'd recommend uing DocXml format because all the above tools work with it, and Visual Studio recognises it (it syntax colours it, and it builds the docs into its intellisense database so it appears in tool-tip help as you type class/method names into your code).

blocks|key|3312439|text|另外，请看一下CppTripleSlash+-+xml+doc+comments+for+c%2B%2B。它是一个免费的Visual+Studio+2015,2013,2012,2010扩展。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|3312440|entityMap|0|LINK|mutability|MUTABLE|url|https://visualstudiogallery.msdn.microsoft.com/22333333-fd6f-4dcb-8223-52701eddd7ad^0|7|15|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

Also, take a look at <a href="https://visualstudiogallery.msdn.microsoft.com/22333333-fd6f-4dcb-8223-52701eddd7ad" rel="nofollow">CppTripleSlash - xml doc comments for c++</a>. It is a free Visual Studio 2015, 2013, 2012, 2010 extension.

blocks|key|3312317|text|生成文档的一种方法是--你猜对了--+javadoc。您只需像往常一样添加注释，javadoc在将它们转换为HTML/LaTeX样式方面做得很好。|type|unstyled|depth|inlineStyleRanges|offset|length|style|BOLD|entityRanges|data|3312318|当然，这不是唯一的解决方案。我会给其他人留点空间。|3312319|entityMap^0|J|7|0|0^^$0|@$1|2|3|4|5|6|7|J|8|@$9|K|A|L|B|C]]|D|@]|E|$]]|$1|F|3|G|5|6|7|M|8|@]|D|@]|E|$]]|$1|H|3|-4|5|6|7|N|8|@]|D|@]|E|$]]]|I|$]]

One way to generate documentation is - you guessed it - javadoc. You simply have to comment the same way you usually do, and javadoc does a good job of converting them to HTML/LaTeX style.

Of course, that's not the only solution. I'll leave room for others.

blocks|key|1904667|text|如果你使用的是Visual+Studio2015，那么有一个为宏浏览器扩展编写的Macro生成器，它使用JavaScript作为它的宏语言。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1904668|项目在github上：https://github.com/cppocl/visual_studio_macros|offset|length|1904669|entityMap|0|LINK|mutability|MUTABLE|url|https://github.com/cppocl/visual_studio_macros^0|0|B|1A|0|0^^$0|@$1|2|3|4|5|6|7|N|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|O|8|@]|9|@$D|P|E|Q|1|R]]|A|$]]|$1|F|3|-4|5|6|7|S|8|@]|9|@]|A|$]]]|G|$H|$5|I|J|K|A|$L|M]]]]

If you are using Visual Studio 2015 then there is a Doxygen generator written for the Macro explorer extension which uses JavaScript for it's macro language.

Project is on github here: <a href="https://github.com/cppocl/visual_studio_macros" rel="nofollow noreferrer">https://github.com/cppocl/visual_studio_macros</a>

blocks|key|1215784|text|如果您不介意一些手写文档，那么sphinx是一个完美的工具。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1215785|http://www.sphinx-doc.org/en/stable/|offset|length|1215786|下面是一个例子：|1215787|http://ceres-solver.org/|1215788|sphinx-build+-b+singlehtml+doc/+build/|code-block|syntax|javascript|1215789|entityMap|0|LINK|mutability|MUTABLE|url|1^0|0|0|10|0|0|0|0|O|1|0|0^^$0|@$1|2|3|4|5|6|7|W|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|X|8|@]|9|@$D|Y|E|Z|1|10]]|A|$]]|$1|F|3|G|5|6|7|11|8|@]|9|@]|A|$]]|$1|H|3|I|5|6|7|12|8|@]|9|@$D|13|E|14|1|15]]|A|$]]|$1|J|3|K|5|L|7|16|8|@]|9|@]|A|$M|N]]|$1|O|3|-4|5|6|7|17|8|@]|9|@]|A|$]]]|P|$Q|$5|R|S|T|A|$U|C]]|V|$5|R|S|T|A|$U|I]]]]

If you don't mind, some hand written documentation, then sphinx is the perfect tool.

<a href="http://www.sphinx-doc.org/en/stable/" rel="nofollow noreferrer">http://www.sphinx-doc.org/en/stable/</a>

and here is example:

<a href="http://ceres-solver.org/" rel="nofollow noreferrer">http://ceres-solver.org/</a>

<pre><code>sphinx-build -b singlehtml doc/ build/
</code></pre>

Is there a way to get documentation(like javadoc) in a visual-c++ project?

I'm using visual studio 2010.

thanks!

Visual studio c++ documentation generator

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云AI代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

功能1上新10个字符

功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符。

功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符。

功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符

功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符

功能4上新

文章&问答评论现已支持表情

全新交互，全新视觉，新增快捷键、悬浮工具栏、高亮块等功能并同时优化现有功能，全面提升创作效率和体验

社区富文本编辑器全新改版！诚邀体验～ 

精选全网热门MCP server，让你的AI更好用 🚀

💥开发者 MCP广场重磅上线！

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

社区新版编辑器体验调研

有没有办法在visual-c++项目中获取文档(比如javadoc)？我使用的是visual studio 2010。谢谢!

问Visual studio c++文档生成器
EN

回答 7

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Visual studio c++文档生成器EN

回答 7

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Visual studio c++文档生成器
EN