Tag: 文档生成

扫描代码注释的工具，并转换为标准格式

我正在研究一个已经看到许多不同作者和许多不同文档样式的C项目。 我是doxygen和其他文档生成工具的忠实粉丝，我想迁移这个项目以使用其中一个系统。 是否有人知道可以扫描源代码注释的工具，如“描述”，“作者”，“文件名”和其他类型的上下文，以智能地将注释转换为标准格式？ 如果不是，我想我可以写一个疯狂的脚本，或手动转换。 谢谢

使用Doxygen与C，您是否评论函数原型或定义？ 或两者？

我正在使用Doxygen和一些嵌入式C源代码。 给定一个.c / .h文件对，你是否将Doxygen注释放在函数原型（.h文件）或函数定义（.c文件）上，还是在两个地方复制它们？ 我遇到一个问题，当我在一个地方而不是另一个地方进行记录时，Doxygen会警告缺少评论; 这是预期的，还是我的Doxygen搞砸了？