PHPDocumentor ist magisch

Zugegeben: Neu ist das feature nicht, wurde es doch bereits schon Juli 2007 mit phpDocumentor 1.4.0 veröffentlicht. Bisher entfiel es für mich allerdings, weil der Code-Assisstent von Zend Neon damit sowieso nicht umgehen konnte. Heute habe ich mir endlich die neue Version zugelegt und wie ich so bin: Wenn neue features da sind (und funktionieren ;) ), wieso dann nicht verwenden?

Spannend ist das auch nicht. Es gibt 2 (eigentlich 4) neue Klassentags.

@property [type] [varname] [description]
@method [type] [name] [signatur] [description]

Wobei property noch zwei zusätzliche Ausprägungen besitzt

@property-read [type] [varname] [description]
@property-write [type] [varname] [description]

property ist recht einfach, weil es doch der normalen Syntax folgt, die schon von var, param oder return bekannt ist. property-read und property-write beschränken dabei das Attribut (das ja eigentlich garnicht existiert ;) ) auf Lesen oder Schreiben. Insofern ist property eigentlich auch nur eine Kombination aus read und write, allerdings übersichtlicher.

method ist etwas unschöner. Das Problem ist, dass das, was vorher auf einen ganzen DocComment verteilt werden konnte, jetzt auf eine Zeile komprimiert werden musste. name bezeichnet den Namen der Methode inklusive (leerer) Klammern (), signatur ist der Name der Methode mit in Klammern stehender Parameter inklusive dessen Typen.

Wie das dann genau aussieht, schaut man sich am Besten in hauseigener Beschreibung an (Link oben). Ich für meinen Teil werde jetzt erstmal ausprobieren, wie dass dann im Ergebniss aussieht.

Gruß,
Müsli

Edit:

OK, es gibt doch ein Manko. Zend Neon kennt zwar auch die neuen Tags und bietet sie im Code-Assisst an, kann sie allerdings nicht auflösen. Vielleicht kommt das noch ;)


Comments

One response to “PHPDocumentor ist magisch”

Leave your response
  1. [...] bin ich eben gerade über einen 2 Jahre alten Beitrag von mir über Magische Methoden und Eigenschaften in PHPDocumentor und Zend Neon [1] gestolpert. Darin geht es um die bösen magischen Methoden und Objekt-Attribute in PHP, die [...]

Bad Behavior has blocked 73 access attempts in the last 7 days.