Comment documenter les attributs de classe en utilisant Doxygen?

Question

Je tente de documenter des attributs de classe en utilisant Doxygen. Actuellement, les attributs protégés apparaissent dans la liste en haut de la page pour la classe spécifique. Je voudrais leur donner une explication.

J'ai essayé d'utiliser @param [name] [description] au-dessus du début de la classe et juste au-dessus de la déclaration des attributs. J'ai même essayé de les mettre dans le docblock pour ma classe de constructeur et ça l'a juste cassé.

Y a-t-il quelque chose qui me manque?

- Logan

Answer 1

Vous devez utiliser < ou des commentaires juste avant l'attribut:

class cMainData 
{ 
    private $attr; //!< This is my attribute 

    //! This is another attribute 
    private $otherAttr; 
} 

Notez que vous pouvez utiliser @brief, @note et par exemple similaire:

class cMainData 
{ 
    private $attr; //!<@brief This is my attribute. 
        //!< This is some additional info about this attribute. 
} 

Answer 2

J'ai posté une solution de contournement comme une réponse à un double de cette question: Doxygen: how to describe class member variables in php? Il peut être utile de le lier d'ici pour d'autres qui ont besoin d'une solution compatible avec ph Style d'annotation pDoc.