Doxygen：记录重载函数

Question

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

void func() {
}

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

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

void func() {
}

void func(int i) {
}

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

- Paul Manta

Answer 1

对于这种情况，有一个\overload doxygen命令。请参阅doxygen命令参考。对于基本情况，请使用常规的\fn命令，并针对任何重载使用\overload命令。 :)

- SolarBear

Answer 2

您可以将每个重载方法都单独记录，就像它们是不同的方法一样（实际上确实如此 :-)）- 只需在 \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) { }

- Jason Williams