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

Question

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

之间区别的StackOverflow帖子

Difference between param[out] and return in doxygen?

如果您在函数中使用指针设置某些内容，则使用

param [out]。如果我有一个在其类中设置变量的方法，那么使用param [out]仍然是正确的（函数是无效的）？

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

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访问）;

Answer 1

param [out]用于传递给函数的指针。从函数中修改的任何外部函数都应记录在案中。

注意：如果你无法解释为什么你在函数中编辑那些没有传入的变量那么你可能会编写错误的代码。