类似Javadoc的C ++文档 [英] Javadoc-like Documentation for C++

问题描述

有没有类似的文档生成系统，如Javadoc，C ++？ Javadoc产生不错的输出;这将是巨大的，如果你可以使用像其他语言的东西。

Are there similar documentation generation systems like Javadoc, for C++? Javadoc produces nice output; It would be great if you could use something like it in other languages.

推荐答案

有几种工具类似JavaDoc for C ++最流行的工具可能是氧气。它可以处理类似JavaDoc的注释，以及几种语言（例如C ++，C，Java，Objective-C，Python，PHP，C＃）。它非常支持使用CSS调整HTML输出的样式（请参阅用户列表示例文档）。

There are several tools that works like JavaDoc for C++ The most popular tool is probably Doxygen. It can handle JavaDoc-like comments, and also several languages (e.g., C++, C, Java, Objective-C, Python, PHP, C#). It has pretty good support for tweaking the style of the HTML output using CSS (see the users list for example documentations).

选择文档系统时的两个重要问题是确保它允许您

Two important issues when choosing the documentation system is to make sure that it allows you to

• 记录您感兴趣的实体。要根据代码结构或根据其他模块部分记录系统。


• 获取输出格式化为您想要的。

我们使用doxygen的经验是，它很容易设置和使用，并且产生的输出是相当容易调整。不幸的是，doxygen不是完美的，所以在某些情况下，有必要解决doxygen解析器崩溃的怪异或错误。请务必仔细检查所有生成的文档。

Our experience with doxygen is that it is pretty easy to set up and use, and the resulting output is fairly easy to tweak. Unfortunately, doxygen is not perfect, so in some cases it is necessary to work around quirks or bugs where the doxygen parser breaks down. Be sure to inspect all of your generated documentation carefully.

这篇关于类似Javadoc的C ++文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！