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

Question

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

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

我有什么东西不见了吗？

- 洛根

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: how to describe class member variables in php?对于需要与phpDoc注释样式兼容的解决方案的其他人来说，将其链接起来可能很有用。