Tag: doxygen

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

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

使用doxygen来记录结构定义之外的ac结构的成员

我正在使用doxygen来评论我的C代码。 我正在使用缺乏文档的外部API（即我自己的API）所以我打算在我自己的源文件中记录一些API。 我确实有外部API的头文件，但将我自己的注释添加到该文件是不切实际的。 外国标题 struct foreignstruct { int a; int b; }; 我的标题 /** My structure comments… struct mystruct { /** Describe field here… */ int field; }; /** @struct foreignstruct * @brief This structure blah blah blah… * @??? a Member ‘a’ contains… * @??? b Member ‘b’ contains… */ 用什么标签代替@??? 获得正确的doxygen输出（其中’correct’表示mystruct和foreignstruct生成输出是相同的）？