类似于Javadoc的C++文档

Question

对于C++,是否有像Javadoc这样的文档生成系统？Javadoc产生了很好的输出; 如果你能在其他语言中使用类似的东西,那就太棒了.

Answer 1

有几种工具可以像JavaDoc for C++一样工作.最流行的工具可能是doxygen.它可以处理类似JavaDoc的注释,也可以处理多种语言(例如,C++,C,Java,Objective-C,Python,PHP,C#).它非常适合使用CSS调整HTML输出的样式(请参阅用户列表中的示例文档).

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

• 记录您感兴趣的实体.是否要按照代码结构或根据其他模块划分来记录系统.
• 根据需要格式化输出.最好是文档符合您的一般项目风格.

我们使用doxygen的经验是它很容易设置和使用,结果输出很容易调整.不幸的是,doxygen并不完美,因此在某些情况下,有必要解决doxygen解析器发生故障的怪癖或错误.请务必仔细检查所有生成的文档.

Answer 2

你不能专门使用javadoc,但有几个工具可以做你想要的.大多数人倾向于使用的是Doxygen.以下是Doxygen和Doc ++的一些链接:

Doxygen
Doc ++

Answer 3

有Doxygen