如何使用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?从此处链接它对于需要与ph兼容的其他人可能很有用pDoc注释样式。