【发布时间】:2012-01-04 10:38:29
【问题描述】:
我希望在记录的 c++ 实现文件(不是头文件)上获得类似的输出,例如使用 docco 生成的输出。有这样的工具吗?
【问题讨论】:
-
你见过Doxygen吗?
-
当然,但我一直在寻找像 docco 这样的并排文档。
标签: c++ c documentation implementation docco
我希望在记录的 c++ 实现文件(不是头文件)上获得类似的输出,例如使用 docco 生成的输出。有这样的工具吗?
【问题讨论】:
标签: c++ c documentation implementation docco
docco 源 (git repo) 具有 c 支持。如果你克隆它,你可以使用 npm 在本地安装它。但是:
我必须将 docco.coffee 编译为 javascript:
cd docco/src
coffee -c docco.coffee
cp docco.js ../lib
如果您在同一目录中具有名称匹配的头文件和 c 文件,则一个会覆盖另一个。
由于某种原因,与 node.js 相关的所有内容都像疯了一样出现段错误,但我认为这一定是我的安装有问题(幸运的是,在生成输出后,最后出现了 docco 段错误)。
更新 - 作为覆盖问题的修复,我克隆了 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
【讨论】:
Docco 声称现在支持这一点 - https://github.com/jashkenas/docco/pull/96
【讨论】:
我不熟悉 docco,但它看起来像是一种文学编程形式。如果是这种情况,您可能需要查看cweb。语法可能不同,但它确实适用于 C++(即使它在设计时考虑了 C)。
【讨论】: