一个文档类属性如何使用 Doxygen？答案

【问题标题】：How does one document class attributes using Doxygen?一个文档类属性如何使用 Doxygen？
【发布时间】：2011-04-01 07:22:51
【问题描述】：

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

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

我有什么遗漏的吗？

-- 洛根

【问题讨论】：

【解决方案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.
}

【讨论】：

【解决方案2】：

我已经发布了一个解决方法作为对这个问题的重复的答案：Doxygen: how to describe class member variables in php? 对于需要与 phpDoc 注释样式兼容的解决方案的其他人，从这里链接它可能很有用。

【讨论】：