Doxygen:是否可以对C++函数参数进行分组，即在不复制的情况下拥有相同的文档

Doxygen: Is it possible to group C++ function parameters, i.e. have the same documentation without duplicating it?

本文关键字：复制 情况下 文档 拥有 是否 C++ 参数 函数 Doxygen      更新时间：2023-10-16

是否可以在Doxygen文档中对函数参数进行分组，这样我就不必重复注释了？例如，我想要这样的东西：

/**
  <...>
  @param {{a, b}} <long documentation>
*/

氧气输出：

<...>
Parameters:
  a,b - <long documentation>

是的，您可以使用@param传递一个逗号分隔的参数列表，如下所示：

/** Sets the object's position.
 *  @param x,y,z Coordinates of the position in 3D space.
 */
void setPosition(double x,double y,double z)
{
}

它将如您所期望的那样出现在输出中。

相关文章：