documentation - 如果语言仅支持访问器，如何在 Doxygen 中记录属性？

Question

在 C/C++ 中，我通常需要记录一个属性，而不仅仅是它的访问器(getter 和 setter)。一些文档系统直接支持这一点，例如 GTK-Doc。但是我如何使用 Doxygen 做到这一点呢？

我在 getter 中描述属性，但这绝对不是解决方案。在 getter 和 setter 中复制描述更糟糕。

一个典型的 C 示例，其中 Obj 是不透明的:

/**
 * Doc for getter
 */
int getSize(Obj* obj);

/**
 * Doc for setter
 */
void setSize(Obj* obj, int size);

// Where to put the documentation for size itself?

Answer 1

你可以这样做:

class SomeClass
{
private:
    m_size ///< Documentation for the property...  
}

请参阅“将文档放在成员之后”部分 here .该页面上指定了各种其他评论格式。您可以选择最适合您现有资源的一种。