Question

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

void func() {
}

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

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

，该怎么办？

void func() {
}

void func(int i) {
}

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

Answer 1

对于这种情况，有一个\ overload doxygen命令。见the doxygen command reference。使用常规\ fn命令作为基本情况，并使用\ overload进行任何，即过载。：）

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) { }

Doxygen：记录重载函数

2 个答案: