In che modo gli attributi di classe un documento utilizzando Doxygen?

Question

Sto tentando di attributi di classe documento usando Doxygen. Attualmente, gli attributi protetti appaiono nella lista nella parte superiore della pagina per la classe specifica. Mi piacerebbe mettere una spiegazione per loro.

Ho provato con @param [name] [description] sia sopra l'inizio della classe e proprio sopra la dichiarazione degli attributi. Ho anche cercato di metterli in docblock per la mia classe costruttore ed è appena rotto esso.

C'è qualcosa che mi manca solo?

- Logan

Answer 1

Devi usare < o un commento a destra prima l'attributo:

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

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

Si noti che è possibile utilizzare @brief, @note e simili per esempio:.

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

Answer 2

ho postato una soluzione come una risposta a un duplicato di questa domanda: Doxygen:?. come descrivere le variabili membro di classe in php può essere utile collegare da qui per gli altri che la soluzione necessità compatibile con stile PHPDoc annotazione