Doxygen：记录重载函数答案

【问题标题】：Doxygen: Documenting overloaded functionsDoxygen：记录重载函数
【发布时间】：2011-08-03 23:33:28
【问题描述】：

如果我的文档与代码分开，我如何帮助 Doxygen 区分重载函数（在 \fn 字段中使用什么）？单个函数的记录如下：

void func() {
}

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

如果我有两个名为 func 的函数怎么办？

void func() {
}

void func(int i) {
}

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

【问题讨论】：

标签： documentation doxygen

【解决方案1】：

对于这种情况有一个 \overload doxygen 命令。见the doxygen command reference。对基本情况使用常规的 \fn 命令，对任何重载使用 \overload。 :)

【讨论】：

【解决方案2】：

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

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

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

（抱歉，我只需要将 doc cmets 移到它们所属的方法之上 :-)

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

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

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

【讨论】：