Module bilden das prozedurale Gegenstück zu einer Klasse. @module definiert den Namen eines Moduls. Module kennen keine Entsprechung im PHP Sprachumfang.

Syntax und Scope
Syntax	@module label
Scope	module

Mehrere Module können in einer Modulgruppe zusammengefaßt werden. Eine Modulgruppe entspricht einer Klasse und allen von ihr abgeleiteten Klassen.

Definition eines Modulekommentars: Ein Modulkommentar ist der erste Doc Comment in einer Datei, die keine Klassen enthält, sofern er @module oder @modulegroup enthält.

Objektorierte Programmierung	Prozedurale Programmierung
Klasse	Modul
Klassenbaum Basisklasse Abgeleitet1 Abgeleitet2	Modulegruppe Modul 1 Modul 2 Modul 3

Codebeispiel

/** * Modul zur Einbindung benötiger Includefiles im Shop-System. * * @module shop_include * @modulegroup shop */ /** * Bindet die zur Ausführung der angemeldeten Aktion notwendigen Dateien ein. * * @param string Aktion: products - Produkte auslesen * order - Bestellung * all - alle Dateien * @access public */ function shopInclude($action = "all") { static $includedFiles = array(); switch (strtolower($action)) { case "products": break; case "order": break; case "all": default: break; } }

Generierte Dokumentation

File: c:/www/apache/doc2//bla/module.php PHPDoc - shop::shop_include Modul zur Einbindung benötiger Includefiles im Shop-System.   private module shop_include Modul zur Einbindung benötiger Includefiles im Shop-System.   Public Method Summary void shopInclude([ string $action ]) Bindet die zur Ausführung der angemeldeten Aktion notwendigen Dateien ein. Public Method Details shopInclude public void shopInclude( [ string $action ] )   Bindet die zur Ausführung der angemeldeten Aktion notwendigen Dateien ein. Parameter string $action = >>"all"<< Aktion: products - Produkte auslesen order - Bestellung all - alle Dateien Returns void

 

Inhalt

<< @magic

|

@modulegroup >>