2009-07-17 64 views
46

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

回答

53

有工作方式类似于JavaDoc中对C几种工具++最流行的工具可能是Doxygen。它可以处理类似JavaDoc的注释,还可以处理多种语言(例如,C++,C,Java,Objective-C,Python,PHP,C#)。它对使用CSS调整HTML输出风格有很好的支持(例如参见users list文档)。选择文件系统时,

两个重要问题是,以确保它可以让你

  • 文档,你所感兴趣的实体。你想记录系统根据下面的代码结构或其他一些模块部门。
  • 根据需要获取格式化的输出。文档最好符合您的一般项目风格。

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

+0

关于解析器崩溃问题,我发现自从转向使用XML注释以来,我的问题似乎已经得到解决,但是再一次没有很多编辑器和IDE支持开箱即用。 – 2012-04-13 14:43:54

20

不能使用的javadoc明确,但有你想要什么做一对夫妇的工具。大多数人倾向于使用的是Doxygen。下面是Doxygen的和DoC++一些链接:

Doxygen
Doc++

+0

Doxygen工作得很好,用于大量的项目。 – 2009-07-17 03:39:18

0

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

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

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