如何使用Doxygen记录类属性？

Question

我正在尝试使用Doxygen记录类属性。目前，受保护的属性在特定类的页面顶部的列表中显示。我想为它们添加一个说明。

我尝试在类的开头之上和属性声明正上方使用@param [name] [description]。我甚至尝试将它们放入我的构造函数类的文档块中，但它只是破坏了它。

我是否有什么遗漏的地方？

-- Logan

- Logan Bibby

Answer 1

您需要在属性之前使用<或注释：

class cMainData
{
    private $attr;  //!< This is my attribute

    //! This is another attribute
    private $otherAttr;
}

请注意，您可以使用 @brief、@note 等类似的标记，例如：

class cMainData
{
    private $attr;  //!<@brief This is my attribute.
                    //!< This is some additional info about this attribute.
}

- Nux

---

哦！这正是我所需要的！可悲的是，自从我提出这个问题已经将近四个月了，但它仍未得到回答。谢谢！ - Logan Bibby

Answer 2

我已经在这个问题的副本中发布了一个解决方法作为答案：Doxygen：如何描述php中的类成员变量？ 对于其他需要与phpDoc注释样式兼容的解决方案的人来说，将其链接到此处可能很有用。

- Goran Rakic