设置类属性时在 Doxygen 中使用 param[out]答案

【问题标题】：Using param[out] in Doxygen when setting a class property设置类属性时在 Doxygen 中使用 param[out]
【发布时间】：2014-10-01 19:29:42
【问题描述】：

我正在使用 Doxygen 来记录我的 c++ 代码。我已阅读有关 \return 和 \param[out]

之间区别的 StackOverflow 帖子

Difference between param[out] and return in doxygen?

param[out] 如果您在函数中使用指针设置某些内容，则使用。如果我有一个在其类中设置变量的方法，使用 param[out] 是否仍然正确（函数为 void）？

我的意思的一个例子 - 我有一种将极坐标输入转换为笛卡尔坐标的方法。

classConstructor(azimuth, elevation, roll)
{
     //set azimuth, elevation, roll
     convertToCartesian(azimuth, elevation, roll)
}

convertToCartesian(azimuth, elevation, roll)
{
     //someCode
     xPos = calcVector.X
     yPos = calcVector.Y
     zPos = calcVector.Z
}

xPos、yPos 和 xPos 是我的类中的私有变量，它们稍后会使用（通过 getter 访问）；

【问题讨论】：

没有。 param[out] 用于被函数更改的函数参数。
有没有办法记录这种类型的操作？
在描述中，也许是使用自然语言？

标签： c++ doxygen

【解决方案1】：

param[out] 用于传递给函数的指针。从函数内部修改的任何外部内容都应使用 cmets 记录。

注意：如果您无法解释为什么要在未传入的函数中编辑变量，那么您可能正在编写错误的代码。

【讨论】：