PHP Classes

File: readme.txt

Recommend this page to a friend!
  Classes of Stephan Krauss   Simple Documenter   readme.txt   Download  
File: readme.txt
Role: Documentation
Content type: text/plain
Description: read me
Class: Simple Documenter
Generate documentation extracted from PHP code
Author: By
Last change:
Date: 19 years ago
Size: 1,799 bytes
 

Contents

Class file image Download
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) ***/