Zur Dokumentation von Klassenvariablen, auch Properties1 oder Member genannt wird in Doxygen2 (u.a.) und PHPDoc3 (phpDocumentor 2) das Tag @var4 5 verwendet.

In PHPDoc wird die folgende Notation verwendet, diese wird so auch in Drupals Coding-Standards6 beschrieben:

/** 
 * Passed command line options 
 * @var string 
 */ 
 protected $commandLineOptions;

…welche in Doxygen leider weder mit Typ noch mit dem zusätzlichen Kommentar angezeigt wird.

PHP Member Data Documenation within Doxygen, PHPDoc Notation

Um das gewünschte Ergebnis in Doxygen zu erzielen, muss hinter dem Typ noch redundanterweise der Name der Variablen7 notiert werden…

/** 
 * Passed command line options 
 * @var string $commandLineOptions 
 */ 
protected $commandLineOptions;

Tada, Typ und der optionale Kommentar werden angezeigt.

PHP Member Data Documenation within Doxygen, Doxygen Notation, redundanter Variablenname

Interessant ist vielleich auch noch Documenting PHP with Doxygen: The Pros and Cons8.

  1. PHP Properties ↩

  2. Doxygen ↩

  3. PHPDoc ↩

  4. PHPDoc @var Tag ↩

  5. Doxygen \var (variable declaration) ↩

  6. Drupals Coding-Standard ↩

  7. stackoverflow: How to set member type in Doxygen for PHP code? ↩

  8. Documenting PHP with Doxygen: The Pros and Cons ↩