Fehlerbehandlung, Dokumentation und Qualitätskontrolle - JavaScript: Die Universelle Sprache zur Web-Programmierung - page 141

Tabelle 6.2■ Kommentar-Token
Token

Beschreibung

Dieser Token fügt den Namen des Autors in der Dokumentation ein.

@author

Der Token markiert ein Element als nicht zu verwenden bzw. veraltet.

@deprecated

Dieser Token dient zur Dokumentation der Parameter.

@param

Mit diesem Token kann der Wert beschrieben werden, der von einer
Methode oder Funktion zurückgegeben wird.

@return

Diese Angabe speziiziert, wann das Release erstellt wurde.

@since

Dieser Token erzeugt eine Rubrik mit Ausnahmen, die von der Methode oder
Funktion erzeugt werden.

@throws

Die Version

@version

6.4.1.1■Praktischer Einsatz mit YuIDoc und JSDoc3
Die drei oben vorgeschlagenen Dokumentationstools arbeiten wie gesagt ähnlich, wobei alle
individuell zu installieren sind und es natürlich diverse Besonderheiten gibt. Als Vertreter
wollen wir hier einmal YUIDoc installieren, was zum Zeitpunkt der Bucherstellung in der
Version 0.3.45 vorliegt, sowie JSDoc3. Mit JSDoc3 wollen wir auch eine konkrete Dokumen-
tation erstellen. Die Entscheidung für diese beiden Tools ist deshalb erfolgt, weil YUIDoc
eine Node.js-Applikation darstellt und wir mit Node.js im Buch später noch mehr zu tun
bekommen. JSDoc können Sie von einem GitHub Repository, aber auch mit dem Paketmana-
ger npm von Node.js installieren und dann auf der Befehlszeile ebenso auf Basis von Node.
js oder der Mozilla Rhino-Engine ausführen 6 . Beide Tools haben also über die reine Doku-
mentationsmöglichkeit die Bedeutung, dass sie einen ersten Kontakt zu der Welt von
Node.js aufbauen.

YuIDoc installieren
Zur Installation von YUIDoc müssen Sie zuerst Node.js und dessen Paketmanager npm
laden und installieren, aber das haben wir ja im ersten Kapitel schon durchgesprochen und
Sie sollten das erledigt haben. In einer Konsole geben Sie dann einfach Folgendes ein:
npm -g install yuidocjs
Das ist alles, was notwendig sein sollte, um in der Folge YUIDoc verwenden zu können. Sie
brauchen im einfachsten Fall bloß in einer Konsole den Befehl yuidoc . (beachten Sie den
Punkt - er steht für das aktuelle Verzeichnis) in dem Verzeichnis aufrufen, in dem sich Ihre
JavaScript-Dateien beinden. Standardmäßig wird die Dokumentation dann in einem Ver-
zeichnis out generiert. Natürlich gibt es noch diverse Einstellungen und Besonderheiten,
aber die sind in der Dokumentation zu dem Tool zu inden. Ebenso sollten Sie beachten,
dass die Strukturen der eigentlichen JavaScripts einige Regeln befolgen müssen, die zwar
auch in der Dokumentation zu inden, aber nicht ganz trivial sind. Zudem beindet sich
YUIDoc noch in einer recht frühen Entwicklungsphase. Deshalb gehen wir das praktische
Beispiel mit JSDoc3 an.

6 Bei jgrousedoc handelt es sich hingegen um ein Java-basierendes Tool, das mit Ant ausgeführt wird.