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

Using param[out] in Doxygen when setting a class property

本文关键字:param out 设置 属性      更新时间:2023-10-16

我正在使用氧气来记录我的c++代码。我读过这个StackOverflow帖子关于return和param[out]之间的区别

参数[out]与氧返回值的差异?

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

param[out]用于传递给函数的指针。函数内部的任何外部修改都应该用注释记录。

注意:如果你不能解释为什么你在一个没有传入的函数中编辑变量,那么你可能写了不好的代码