PHP Classes

Simple Documenter: Generate documentation extracted from PHP code

Recommend this page to a friend!
  Info   View files View files (5)   DownloadInstall with Composer Download .zip   Reputation   Support forum (1)   Blog    
Ratings Unique User Downloads Download Rankings
Not enough user ratingsTotal: 722 All time: 4,590 This week: 560Up
Version License Categories
documenter 1.0GNU Lesser Genera...Tools
Description 

Author

This class serves for the purpose of automatically generating documentation from the script files of classes and global function.

The class extracts information that is contained in the PHP code files for which the documentation is generated.

The documentation of the classes or functions is outputted to a page or stored in a file.

The code and comments of the class are in German.

Picture of Stephan Krauss
Name: Stephan Krauss <contact>
Classes: 3 packages by
Country: Germany Germany
Age: 65
All time rank: 1561101 in Germany Germany
Week rank: 307 Up15 in Germany Germany Up

Details

Diese Klasse dient zur dokumentation von Klassen und Funktionssammlungen. Durch die Verwendung von Informationsblöcken können Dateien, Funktionen und Klassen beschrieben werden. Dadurch ist das erstellen einer Dokumentation möglich. Die Dokumentation der Klasse / Funktionen wird auf dem Bildschirm angezeigt und in einer Datei abgespeichert. Es empfiehlt sich, daß im Editor die Informationsblöcke als 'snippet' abzuspeichern. This class serves for the documentation of classes and function collections. By the use of information blocks files, functions can and Classes to be described. Thus is that provide a documentation possible. The documentation of the class/functions is indicated on the screen and in a file stored. It is advisable that in the editor the information blocks as "snippet" to store. Für die Beschreibung von Funktionen und Methoden von Klassen wird nachfolgender Informationsblock verwendet. For the description of functions and methods of classes becomes following Information block uses. /** Name: Kurzbeschreibung: Beschreibung: Typ: public Input: $ = $ = $ = Output: $ = ***/ Die Parameter dieses Blockes sind. Name: (name of the function) Kurzbeschreibung: (short description of the function) Beschreibung: (Description) Typ: Input: Output: Beispiel: (Example) /** Name: formularkontrolle() Kurzbeschreibung: uebernimmt die Variablen des Formulares Beschreibung: Speichert die Formularvariablen in ein Array 'intern' Typ: public Input: $intern = Inhalt des Formulares ***/ Mit nachfolgenden Informationsblock kann der Inhalt der Datei beschrieben werden. /** Datei: (name of the file) Beschreibung: (description) ***/

  Files folder image Files  
File Role Description
Plain text file documenter.inc Class documenter class
Accessible without login Plain text file example.php Example example
Accessible without login HTML file file.htm Output A goal
Accessible without login Plain text file file.php Example Source
Accessible without login Plain text file readme.txt Doc. read me

 Version Control Unique User Downloads Download Rankings  
 0%
Total:722
This week:0
All time:4,590
This week:560Up