Zorg API Doku
| Bug # | 656 | ||||
| Priorität | 4 (▼ Niedrig) | ||||
| Bereich | Code | ||||
| Title | Zorg API Doku | ||||
| Beschreibung | In der Zorg API Doku sollte erwähnt werden, dass in Funktionen für DB- und User-Funktionen die entsprechenden Globalen Variablen geholt werden müssen: global $db, $user; Sonst geht nix. Zudem sollte ein Standart für die Funktionen-Beschreibung definiert werden, vorzüglich im PHPDocu-Stil. Bsp.: /** * Meine Klasse * * @author IneX * @date 23.05.2009 * @version 1.0 * @desc Kurz-Beschreibung meiner läässen Klasse * @package Zorg * @subpackage Meine Klasse * * Lange Beschreibung meiner tollen * Funktion. Hier kann ich auf mehreren * Zeilen schreiben, was ich will. * Natürlich müssen nicht alle Parameter * für die Doku verwendet werden. */ class MeineKlasse { /** * Meine Funktion * @author IneX * @version 1.0 * @since 1.0 (Version der Klasse) * @desc Kurz-Beschreibung meiner Funktion * @package Zorg * @subpackage Meine Klasse * * @return string * @param $user_id User-ID */ function MeineFunktion($user_id) { global $db, $user; // Für DB Operationen & User Variablen // Code... } } | ||||
| Reported by | IneX @ | ||||
| Git Commit | |||||
| Assigned to | IneX @ 19.05.2009 19:30 | ||||
| Status | Resolved @ | ||||
| |||||
| ||||||