Hi,
wer sauber programmiert, verziert häufig eine Funktion mit einem Kommentarblock, indem die Aufgabe der Funktion, Übergabeparameter, Rückgabewert, Autor und so weiter beschrieben werden.
Mir fällt einfach nichtmehr ein, wie man diesen „Block“ nennt.
Könnt ihr mit helfen?
Beispiel:
/*
* @desc Beschreibung der Funktion
* @arg1 integer
* @arg2 integer
* @return string
* @author Hans Lustig
*/
function meineFnktion (int a, int b) {
…
Hallo,
Mir fällt einfach nichtmehr ein, wie man diesen „Block“ nennt.
einen speziellen Namen kenne ich nicht. Mir fallen nur Begriffe wie Kommentar, (API-)Dokumentation oder Schnittstellenbeschreibung ein.
Andreas
wer sauber programmiert, verziert häufig eine Funktion mit
einem Kommentarblock, indem die Aufgabe der Funktion,
Übergabeparameter, Rückgabewert, Autor und so weiter
beschrieben werden.
Mir fällt einfach nichtmehr ein, wie man diesen „Block“ nennt.
Hallo Conan,
vielleicht Definition und Deklaration.
Gruß
Reinhard
Hallo Conan2011,
wer sauber programmiert, verziert häufig eine Funktion mit
einem Kommentarblock, indem die Aufgabe der Funktion,
Übergabeparameter, Rückgabewert, Autor und so weiter
beschrieben werden.Mir fällt einfach nichtmehr ein, wie man diesen „Block“ nennt.
Beispiel:
/*
* @desc Beschreibung der Funktion
* @arg1 integer
* @return string
* @author Hans Lustig
*/
function meineFnktion (int a) {
…
Der Block ist eine Inline-Dokumentation des Quellcodes.
Die Formatierung des Blocks ist so gewählt, dass mit einem
entsprechenden Parser aus dem Quellcode eine Dokumentation
(i.d.R. in HTML) erstellt werden kann.
Je nach (Quell-) Programmiersprache und verwendetem Parser
heißen diese Blöcke anders:
Java: Javadoc (http://de.wikipedia.org/wiki/Javadoc)
PHP: PHPDoc (http://de.wikipedia.org/wiki/PhpDocumentor)
ActionScript: ASDoc (http://opensource.adobe.com/wiki/display/flexsdk/ASD…)
usw.
Doxygen (http://www.doxygen.org/) ist ein Tool, das
„C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft
flavors), Fortran, VHDL, PHP, C#, and to some extent D“
parsen kann.
Für viele der o.g. Parser gibt es Anleitungen, Tutorials und
Informationen darüber, was man noch so alles mit den
„Docs“ machen kann (einfach mal googeln oder den Links oben
folgen).
Viele Grüße
Thomas