Was ist der Zweck dieser PHPDoc Eigenschaften?

Question

Im Allgemeinen ist die PHPDoc Eigenschaften sind selbsterklärend, aber ich habe diese harte Zeit zu verstehen:

@category - was ist das genau

@package - könnte jemand mir Beispiele über die Verwendung dieser Eigenschaft bietet

Answer 1

Der Paket-Tag ist der Schlüssel Organisations Tag, dass Sie in Ihrem Code verwenden. Wenn phpDocumentor die Dokumentation erzeugt, sammelt es Elemente in die Pakete, die Sie festlegen. In einigen Fällen können wählen Sie nur einen Paketnamen zu verwenden (@package MyPackage) für die gesamte Code-Basis, so dass alle Dateien, Klassen, etc., in dem Paket der Dokumente angezeigt werden.

Wenn Sie jedoch wählen, Dinge zu organisieren mehr modular, könnten Sie haben alle Web gerichteten Verfahrens Dateien in einem Paket (@package Webpages), alle Datenbank gerichteten Klassen in einem Paket (@package DatabaseHandlers), alle Utility-Klassen in ein Paket (@package Utilites), und so weiter.

Das Wichtigste über @package zu erinnern ist, dass es Ihr Weg ist für die Dokumentation der Organisation ... es hat nichts mit, wie der Code ausführt, zu tun. Nun, offensichtlich sind Sie eher die Dokumentation organisieren zu wollen, basierend darauf, wie Sie vom Konzept her die Stücke Ihrer App in Ihrem Kopf organisieren, so dass in diesem Sinne „Paket“ würde Gefühl, wie es ist < em> Code der Organisation ... Aber am Ende, der Paket-Tag ist alles darüber, wie Sie phpDocumentor wollen die Dokumentation organisieren.

Wie für die Kategorie-Tag, ich glaube nicht, irgendwelche Ausgangswandler verwenden, dass mit Ausnahme der (n), dass die Materie auf die PEAR-Projekt. Kategorie zu sammeln Sätze von Paketen in einem großen Bündel verwendet. Aber auch dies ist nur relevant für PEAR, soweit welche Fähigkeiten sind bereits in den Ausgangswandler gebacken. Sie können Diesen Tag ignorieren, wenn Sie wollen ... Sie kann nicht das Paket-Tag ignorieren, weil es Kern, wie phpDocumentor organisiert die Dokumentation ist.

Nun zu Beispielen für @package verwendet, gibt es einige im Handbuch, wie seengee bereits erwähnt. Lange Rede kurzer Sinn, benötigen Sie einen Paket-Tag in dem Datei-Ebene Docblock jede Datei (das ist, wo global scoped Funktionen und Konstanten erhalten würden ihr „Paket“ aus), und in der Docblock jeder Klasse. Wenn Sie nicht Paket Werte für diese Codeelemente bereitzustellen, wird phpDocumentor nur gezwungen Dump sie alle in einem Paket „Default“.

Letzter Punkt ..., wenn Sie nicht über die Organisation Ihren Code in verschiedene Pakete kümmern, und wollen nicht zu bearbeiten Sie alle Ihre Dateien die @package Tags hinzuzufügen, können Sie stattdessen das -dn Laufzeit verwenden Argument Set ein Standardpaketname [1]. Dies sagt phpDocumentor den Paketnamen für alle „ausgepackt“ Code-Elemente in diesem Argument verwenden Sie zur Verfügung stellen, dass es einen Paketnamen für möchte. Es gibt auch ein -dc Argument einen Standardkategorienamen zu setzen, aber das ist weit weniger kritisch ein Bedarf bis phpDocumentor betroffen ist.

[1] -

Answer 2

@Category

  

Der @Category Tag dient dazu, zu organisieren   Gruppen von Paketen zusammen.

     

Dies ist   unmittelbar auf die   XML: DocBook / peardoc2 Converter, und   kann von anderen Wandlern verwendet werden. Andere   Converters verpackt mit phpDocumentor   ignorieren die Kategorie, aber dies kann   ändern in zukünftigen Versionen. Es ist auch   möglich dynamisch zu spezifizieren   Kategorie der -dc verwenden,   --defaultcategoryname Befehlszeilenoption

http://manual.phpdoc.org/HTMLSmartyConverter /HandS/phpDocumentor/tutorial_tags.category.pkg.html

@package

  

@package kann nur Dokument verwendet werden,   Verfahrens Seiten oder Klassen.

     

Pakete werden verwendet, um Ihnen zu helfen   logisch Gruppenelemente zusammen. Du   Schreibklassen, um verwandte   Funktionen und Daten zusammen und   phpDocumentor repräsentiert den Inhalt   von Dateien (Funktionen, definiert, und   enthält) als „Verfahren Seiten.“ EIN   Paket wird auf Gruppenunterricht verwendet und   Verfahrens Seiten zusammen in der gleichen   Art und Weise, dass ein Verzeichnisgruppe bezogen   Dateien zusammen.

http://manual.phpdoc.org/HTMLSmartyConverter /HandS/phpDocumentor/tutorial_tags.package.pkg.html

Answer 3

@Category

  

Der @Category Tag dient dazu, zu organisieren   Gruppen von Paketen zusammen.

     

Dies ist   unmittelbar auf die   XML: DocBook / peardoc2 Converter, und   kann von anderen Wandlern verwendet werden. Andere   Converters verpackt mit phpDocumentor   ignorieren die Kategorie, aber dies kann   ändern in zukünftigen Versionen. Es ist auch   möglich dynamisch zu spezifizieren   Kategorie der -dc verwenden,   --defaultcategoryname Befehlszeilenoption

http://manual.phpdoc.org/HTMLSmartyConverter /HandS/phpDocumentor/tutorial_tags.category.pkg.html

@package

  

@package kann nur Dokument verwendet werden,   Verfahrens Seiten oder Klassen.

     

Pakete werden verwendet, um Ihnen zu helfen   logisch Gruppenelemente zusammen. Du   Schreibklassen, um verwandte   Funktionen und Daten zusammen und   phpDocumentor repräsentiert den Inhalt   von Dateien (Funktionen, definiert, und   enthält) als „Verfahren Seiten.“ EIN   Paket wird auf Gruppenunterricht verwendet und   Verfahrens Seiten zusammen in der gleichen   Art und Weise, dass ein Verzeichnisgruppe bezogen   Dateien zusammen.

http://manual.phpdoc.org/HTMLSmartyConverter /HandS/phpDocumentor/tutorial_tags.package.pkg.html