由于某些原因,我想记录一个 API,但我不想直接在源代码中编写文档,因为它现在已经被广泛使用。我正在寻找一个文档生成器工具,它可以将文档文件作为输入,并且能够从源代码中获取函数原型并检查与文档的一致性。你知道任何可以做到这一点的工具吗?
问问题
1233 次
1 回答
6
当文档文本在其源代码之外时, Doxygen也可以记录代码。只需创建一个文本为注释的源文件,其中包含标题:
例如,如果您有
源.H
void func();
你可以加
来源.DOX
/**
\function void func()
Your usual doxygen text here.
*/
并生成使 doxygen 接受 .h 和 .dox 文件的文档。
于 2013-08-17T17:01:03.083 回答