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

Question

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

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

有什么我只是想念的吗？

——洛根

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

Answer 2

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