如何使用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註釋樣式。