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

标签 c++ c documentation implementation docco

<分区>

我希望在记录的 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.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

关于c++ - 是否有像 docco 这样的 C/C++ 源代码文档生成器?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/8725433/

相关文章:

std::vector 的 C++ 模板包装器类

c++ - 在给定 XWindow* 的 X (*nix) 上实现剪贴板功能?

java - 继承javadoc,不为继承源生成文档

pdf - 如何获得 kubernetes 文档的 PDF/打印版本?

c++ - 在 C++ 中拆分一个数字

C++静态模板成员初始化问题

c - 查找二维数组中的交集

c - 为什么我除法时会跳过数字?

objective-c - 在 iOS 中计算非整数指数

regex - 是否有关于 VBScript 正则表达式对象 (RegExp) 的良好文档?