Question

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

这里是一个例子：

File1.h （自动生成）

void foo(int a);

File1.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*/
}

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

Answer 1

过了一会儿，我找到了问题的答案。可以在任何需要的地方对任何函数或成员函数添加注释。添加@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的评论和帮助。

使用Doxygen在不同文件中的注释功能

1 个答案: