由于某些原因,我想编写一个API文档,但是我不想直接在源代码中编写文档,因为它已经被广泛使用。我正在寻找一个文档生成器工具,该工具可以将文档文件作为输入,并能够从源代码获取函数原型(prototype)并检查与文档的一致性。您知道有什么工具可以做到这一点吗?
最佳答案
当文档文本不在源代码范围内时,Doxygen也可以记录代码。只需创建一个文本为注释的源文件,其中包含标题:
例如,如果您有
SOURCE.H
void func();
你可以加
SOURCE.DOX
/**
\function void func()
Your usual doxygen text here.
*/
并生成使doxygen接受.h和.dox文件的文档。
关于c++ - 代码文件外的代码文档,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/18291017/