使用 Doxygen 在不同文件中注释函数

Commenting functions in different file with Doxygen

本文关键字：注释 函数 文件 Doxygen 使用      更新时间：2023-10-16

我需要在几个C++项目中注释一组函数。注释的目标是使用 Doxygen 创建一个 HTML 文档。某些项目文件(.h 和 .cpp(由一种机器人自动写入，并且无法更改生成过程。我希望能够注释在此类文件中声明和定义的函数。我想知道是否可以在不同的文件中注释一个函数，以便允许 Doxygen 构建 HTML 和图表文件。

下面是一个例子：

文件1.h(自动生成(

void foo(int a);

文件1.cpp(自动生成(

#include "File1.h"
void foo(int a)
{
/*Function body*/
}

main.cpp(手写，想写什么都可以(

#include "File1.h"
/**
Some proper comments for documenting function foo declared in File1.h and defined in File1.cpp
*/
int main(int a)
{
/*Main body*/
}

感谢您的帮助、建议和提示。 最好的东西。

过了一会儿，我找到了问题的答案。 可以在任何希望的地方对任何函数或成员函数放置注释。添加@fn命令来定义您正在注释的函数或成员就足够了。

在我的问题中开始完成示例，main.cpp文件将如下所示：

#include "File1.h"
/** @fn void myclass::foo(int a)
*  @brief A member function.
*  @param a: input parameter.
*/
int main(int a)
{
/*Main body*/
}

如果你的函数不是类成员，就这样写：

/** @fn void foo(int a)
*  @brief A member function.
*  @param a: input parameter.
*/

感谢您在idclev 463035818的评论和帮助。

相关文章：