是否有像docco这样的C / C++源代码文档生成器

Is there a source code documentation generator for C / C++ like docco?

本文关键字:源代码 C++ 文档 docco 是否      更新时间:2023-10-16

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

docco 源代码(git repo(具有C支持。 如果你克隆它,你可以用 npm 在本地安装它。 然而:

  • 我不得不将docco.coffee编译为JavaScript:

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

  • 出于某种原因,与 Node.js 相关的所有内容都疯狂地分段错误,但我认为这一定是我的安装出了问题(幸运的是,在生成输出后,docco 段错误在最后(。

更新 - 作为覆盖问题的修复,我克隆了存储库并删除了文件扩展名。 所以foo.h现在转到不会覆盖foo.c.htmlfoo.h.html. 您可以从 https://github.com/andrewcooke/docco 中获取副本

我还重新编译了 JavaScript,所以要使用,请执行以下操作:

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

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

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