[Erledigt] phpdocumentor @package

[Forumsgast]

Hallo

ich versuche mir gerade das kommentieren mit / für phpDocumentor anzugewöhnen. Leider habe ich noch ein Problem mit dem @package.
Ich bin mir nicht ganz klar, wo ich das einsetzen soll.
Ist es dafür gedacht, Bereiche zu gruppieren? Um z.B. zu sagen, dass diese klasse und diese Funktionen in Bereich @package Musikdownload, das hier gehört in @package Musikupload und das hier gehört in @package Musikupload @subpackage Eingabeüberprüfung

Soll ich dann in den Header der Datei auch ein @package packen?

[Forumsgast]

Ich würde pro Datei bzw. pro Klasse ein @package verwenden und alles etwas gröber strukturieren. Musikdownload und Musikupload wären bei mir

@package filemanagement

oder so ähnlich. Im Endeffekt ist das wahrscheinlich bei jedem Entwickler/Projekt unterschiedlich.

[Forumsgast]

Ich würde pro Datei bzw. pro Klasse ein @package verwenden und alles etwas gröber strukturieren. Musikdownload und Musikupload wären bei mir

@package filemanagement

oder so ähnlich. Im Endeffekt ist das wahrscheinlich bei jedem Entwickler/Projekt unterschiedlich.

soll ich den funktionen in der klasse dann kein @package zuweisen?
Also für mich ist das ein total neuer Schritt. Hab da noch keine genaue Vorstellung davon.

[Forumsgast]

soll ich den funktionen in der klasse dann kein @package zuweisen?

@package can only be used to document procedural pages or classes.

[...]

If found in a page-level DocBlock, packagename specifies the package that all functions, includes, and defines in the php file belong to. If found in a class-level DocBlock, packagename specifies the package that the class belongs to.

Es geht hier IMHO um eine funktionale Abgrenzung. Wenn bei dir die einzelnen Funktionen einer Klasse komplett unterschiedliche Themenfelder abdecken, stimmt schon was nicht in der Objektorientierung.

[Forumsgast]

Es geht hier IMHO um eine funktionale Abgrenzung. Wenn bei dir die einzelnen Funktionen einer Klasse komplett unterschiedliche Themenfelder abdecken, stimmt schon was nicht in der Objektorientierung.

stimmt da ist was dran. danke.