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

JSDoc3 installieren
Die Installation mit npm ist wieder ganz einfach. In einer Konsole brauchen Sie bloß Folgen-
des einzugeben:
npm install git+https://github.com/jsdoc3/jsdoc.git
HInWEIS: Beachten Sie, dass Sie als Basis des Tools Java benötigen und even-
tuell Pfadangaben beachten müssen. Das ist aber in der Dokumentation alles
beschrieben.
Mit jsdoc [JavaScriptDatei].js (Windows) bzw. ./jsdoc [JavaScriptDatei].js (Linux) können Sie
nun die Dokumentation erzeugen, wenn Sie sich in der Konsole in dem Verzeichnis für die
JavaScript-Dateien beinden. Damit wird in der Grundeinstellung wieder ein out -Verzeich-
nis mit der Dokumentation erzeugt. Mit jsdoc - -help bekommen Sie eine komplette Liste
aller Optionen auf der Befehlszeile angezeigt, wenn Sie das benötigen.
Ein konkretes Beispiel
Wir werden für die Praxis einfach mal eine JavaScript-Datei mit Funktionen und passenden
Kommentaren auswählen. Beachten Sie das folgende Listing, das wir bereits ohne Kommen-
tare bei rekursiven Funktionen verwendet haben (kap6_2.js):
Listing 6.5■ Dokumentierter JavaScript-Code
/**
* @author Ralph - www.rjs.de
* Globale Variable, die von der Funktion fkt() erhöht wird
*/
var i;
/**
* Aufruffunktion für die rekursive Funktion rekFkt()
* @version 1.0
* @author Ralph - www.rjs.de
*/
function fkt() {
i = 0;
rekFkt();
alert(i);
}
/**
* Rekursive Funktion zum Erhöhen der globalen Variable i
* @author Ralph - www.rjs.de
*/
function rekFkt() {
i += Math.random();
if (i < 2)
rekFkt();
}
/**
* Rekursive Funktion zur Berechnung der Fakultät
* @return Zwischenwert
* @param {Object} n
*/