c++ - Doxygen 的 param[out]、引用和构造函数

Question

请考虑以下示例:

class Example
{
    int &_m;

public:
    /**
     * An example constructor.
     *
     * @param myint Reference to some int.
     */
    Example(int& myint)
        : _m(myint)
    {
    }

    void change()
    {
        _m = 5;
    }
};

我应该将myint参数标记为@param[out]吗？构造函数本身并不将其用作输出参数，而是存储在类中并且可以通过 change() 方法进行修改。

以下经验法则是否有意义:@param[in] 用于const 指针和引用，@param[in,out] 对于非 const 的？

Answer 1

该文档是为您和您所在类(class)的读者准备的，因此它应该提供能够最清楚地说明正在发生的事情的信息。该对象似乎旨在写入引用。所以将其标记为 out 参数并不是没有道理的。如果它准确地传达了引用参数的预期用途，那么您应该这样使用它。