php - 一个文档如何使用 Doxygen 类属性？

Question

我正在尝试使用 Doxygen 记录类属性。目前， protected 属性显示在特定类页面顶部的列表中。我想给他们一个解释。

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

有什么我想念的吗？

-- 洛根

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.
}