是否有类似docco的C / C ++源代码文档生成器?

时间:2012-01-04 10:38:30

标签: c++ c documentation implementation docco

我希望在记录的c ++实现文件(不是头文件)上获得类似的输出,例如使用docco生成的输出。有这样的工具吗?

3 个答案:

答案 0 :(得分:2)

docco源代码(git repo)有c支持。如果您克隆它,您可以使用npm在本地安装它。但是:

  • 我必须将docco.coffee编译为javascript:

    cd docco/src
    coffee -c docco.coffee
    cp docco.js ../lib
    
  • 如果您的头文件和具有匹配名称的c文件在同一目录中,则会覆盖另一个。

  • 由于某些原因,所有与node.js相关的东西都像疯了一样疯狂,但我认为这对我的安装来说肯定有问题(幸运的是,在生成输出后,最后是docco段错误。)

    < / LI>

update - 作为覆盖问题的修复,我克隆了repo并删除了文件扩展名的删除。所以foo.h现在转到foo.h.html,而不会覆盖foo.c.html。您可以从https://github.com/andrewcooke/docco

获取副本

我也重新编译了javascript,所以要使用类似的东西:

git clone git://github.com/andrewcooke/docco.git
npm install docco
docco src/*.c src/*.h

答案 1 :(得分:1)

Docco声称现在支持这一点 - https://github.com/jashkenas/docco/pull/96

答案 2 :(得分:0)

我不熟悉docco,但它看起来像是一种有文化的编程形式。如果是这种情况,您可能需要查看cweb。语法可能有所不同,但它确实适用于C ++(即使它是在考虑到C的情况下设计的)。