C ++的类Javadoc文档

有类似的文档生成系统,如Javadoc,C ++? Javadoc产生很好的输出; 如果你能在其他语言中使用类似的东西,那将是非常好的。

5 Solutions collect form web for “C ++的类Javadoc文档”

有几种工具可以像JavaDoc for C ++一样工作,最stream行的工具可能是Doxygen 。 它可以处理类似JavaDoc的注释,还可以处理多种语言(例如,C ++,C,Java,Objective-C,Python,PHP,C#)。 它有很好的支持来调整使用CSS的HTML输出样式(请参阅用户列表中的示例文档)。

select文档系统时,两个重要的问题是确保它可以让你

  • logging您感兴趣的实体。是否要根据代码结构或根据其他模块部门来logging系统。
  • 根据需要获取格式化的输出。 文档最好符合您的一般项目风格。

我们使用doxygen的经验是,设置和使用起来非常简单,而且最终的输出结果很容易调整。 不幸的是,doxygen并不完美,所以在某些情况下,需要解决doxygenparsing器崩溃的怪癖或错误。 一定要仔细检查所有生成的文档。

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

Doxygen的
文档++

有Doxygen

基于QT的C ++项目也有qdoc。 http://doc-snapshot.qt-project.org/qdoc

我刚刚开始为我的Python项目使用Sphinx 。 其主页声明“C / C ++已经被支持”。

它使用一个称为“ reStructuredText ”的轻量级标记。

我刚刚开始将它用于我的Python项目,并且非常喜欢输出的外观。

  • Javadoc:没有HTML标签的换行符?
  • 使用javadoc的Python文档
  • / *(非javadoc)含义
  • Javadoc评论是否应该添加到实现?
  • 如何使生成的类包含来自XML Schema文档的Javadoc
  • 当Javadoc标签不完整时,Maven不能在Java 8中工作
  • 如何在Eclipse中生成Javadoc注释?
  • Eclipse如何链接一个包含javadocs /源的jar与它的二进制文件?
  • Javadoc重用和重载的方法
  • 有没有一些好的和现代的替代Javadoc?
  • 撰写伟大的Javadoc的技术提示