Question

与Using Doxygen with C, do you comment the function prototype or the definition? Or both?相关。

我认为正确的方法是使用\ param，\ return和\ brief对.h函数原型进行操作，因为这会隐藏实现并仅将API暴露给包含我的.h文件的函数;并使用更多\ details来对.c函数实现进行doxygen。到现在为止还挺好。这也是stackoverflow的建议。

是否有可能告诉doxygen结合.c和.h文档？因为.c实现可以是原型，我甚至不需要.h函数原型，但我需要doxygen将.h doxygen \ param，\ return和\ brief拉到.c实现html和latex中的文档。现在，在不同的地方有两次功能是令人困惑和痛苦的。至少，我希望\ param，\ return和\ brief能够与函数实现重新出现。

/ IAW

Answer 1

如果这是你的标题：

/**
 * @brief Main function
 * 
 * @param argc number of arguments
 * @param argv array of arguments
 * 
 * @return 0
 */
int main(int argc, char* argv[]);

这是你的来源：

/**
 * @internal
 *
 * This is an internal implementation command.
 * 
 * @endinternal
 */
int main(int argc, char* argv[])
{
    return 0;
}

您的评论将合并到文档中。在此示例中，必须在配置中启用INTERNAL_DOCS才能获得实现注释。您将在头文件的页面中找到合并的文档。源文件的页面仅显示实现命令。

doxygen ---将.c和.h doc结合起来用于相同的文件？

1 个答案: