Documentation Doxygen：记录重载函数

如果将文档与代码分开，如何帮助Doxygen区分重载函数（在

\fn

字段中使用什么）？单个功能的文档记录如下：

void func() {
}

/**
    \fn func
    \details Description here.
  */

如果我有两个名为

func

的函数呢

void func() {
}

void func(int i) {
}

/**
    \fn [What goes here?]
    \details Description here.
  */

---

对于这种情况，有一个\重载doxygen命令。看见对基本情况使用常规\fn命令，对任何重载使用\重载。：）

您可以简单地记录每个重载，就像它是一个单独的方法一样（实际上是：-）-只需将整个方法签名放在\fn命令中，而不仅仅是方法的名称。例如：

/**
    \fn func()
    \details Description here.
 */
void func() { }

/**
    \fn func(int i)
    \details Description here.
 */
void func(int i) { }

（很抱歉，我不得不将文档注释移到它们所属的方法上方：-）

实际上，如果注释直接位于它所属的代码元素的前面，则根本不需要\fn命令

/**
    \details Description here.
 */
void func() { }

/**
    \details Description here.
 */
void func(int i) { }