Joomla! Kommentar-Standards

Drucken
35 Bewertungen
Anmerkung des Übersetzers: Der Zeilenumbruch nach 75-85 Zeichen ist wegen einiger zeilenspezifischer Anmerkungen nicht möglich gewesen. Falls Sie entwickeln behalten Sie bitte die vorgegebene Zeilenlänge bei.

Beginn des Dokumentes hier:

Start des Dokumentes
Joomla! Programmier-Dokumentation Schnellstart

Diese Datei demonstriert die reichhaltigen Informationen, die innerhalb des Programmcodes (in-code) enthalten sein können und nachfolgend benutzt werden können, um eine Dokumentation für Joomla!-Komponenten mit Hilfe von  „phpDocumentor“ zu erstellen.
--
Beispielcode:
**
* Joomla Coding Documentation Quickstart
*
* This file demonstrates the rich information
* that can be included in-code and subsequently
* used to generate documentation for Joomla!
* components using phpDocumentor
*
* This is a copy of sample2.php by Greg Beaver of
* php.net and is provided with phpDocumentor package.
*
* @author copy/pasted by Predator
* @package sample
*/

Beschreibungen zu eingebunden Dateien hinzufügen

Beispielcode:

/**
* Provide a description of 'include' or 'required'
* and its purpose
*/
include_once 'sample3.php';



Benutzen Sie spezielle Erklärungen für globale Varianten

Beispielcode:
/**
* Special global variable declaration DocBlock
* @global integer $GLOBALS['_myvar']
* @name $_myvar
*/
$GLOBALS['_myvar'] = 6;


Benutzen Sie spezielle Erklärungen für Konstanten

Beispielcode:
/**#@+
* Constants
*/
/**
* first constant
*/
define('testing', 6);
/**
* second constant
*/
define('anotherconstant', strlen('hello'));

/**#@-*/


Funktionen oder Methoden haben einige wertvolle Informationen die erklärt werden können

Beispielcode:
/**
* A sample function docblock
* @global string document that this function uses $_myvar
* @staticvar integer $staticvar this is what is returned
* @param string $param1 name to declare
* @param string $param2 value of the name
* @return integer
*/
function firstFunc( $param1, $param2 = 'optional' ){
static $staticvar = 7;
global $_myvar;
return $staticvar;
}


Ausserdem auch viele Erklärungen für Klassen (Classes)

Beispielcode:
/**
* Die erste Beispiel-KLasse ist im gleiche Paket
* wie am Anfang der Datei beschrieben, aber
* dieses Beispiel hat ein definiertes Unterpaket
* @Beispielpaket
* @Unterpaket Klassen
*/
Klasse meinekategorie {
/**
* ein eigene Beispielvariable, die mit --parseprivate
* option versteckt werden kann
* @Zugang privat
* @var integer|string
*/
var $firstvar = 6;
/**
* @link http://www.example.com Beispiel-Link
* @ siehe meinekategorie()
* @benutzt testend, anderekonstante
* @var array
*/
var $secondvar =
array(
'stuff' =>
array(
6,
17,
'armadillo'
),
testing => anderekonstante
);

/**
* Konstrukteur (constructor) setzt fest {@link $firstvar}
*/
function keinekategorie(){
$this->firstvar = 7;
}

/**
* Gibt ein Dinglein (Anm.: thingie-australischer Slang)
* basierend auf $paramie zurück
* @param boolean $paramie
* @return integer|babyclass
*/
function parentfunc( $paramie ){
if ($paramie) {
return 6;
} else {
return new babyclass;
}
}
}

Hier ist eine Unterklasse des vorherigen Beispiels

Beispielcode:

* @Paket Beipiel1
*/
Klasse babyclass vergrössert meinekategorie {
/**
* Die Antowrt auf das Leben, das Universum und Alles
* @var integer
*/
var $secondvar = 42;
/**
* Konfiguration Werte
* @var array
*/
var $thirdvar;

/**
* Ruft den Eltern-Konstrukteur (parent constructor) auf, erhöht dann {@link $firstvar}
*/
function babyclass(){
parent::meinekategorie();
$this->firstvar++;
}

/**
* Das gibt immer eine „meinekategorie“ zurück
* @param ignoriert $paramie
* @Rückgabe/Ausgabe meinekategorie
*/
function parentfunc( $paramie ){
return new myclass;
}
}

0 Kommentare

Kommentar schreiben