Java Reference
In-Depth Information
einen Browser laden können. Sie sehen dort in unserem Fall alle globalen Elemente der
dokumentierten JavaScript-Datei. Sollten Sie objektorientierte Strukturen verwenden, wer-
den dort gegebenenfalls noch weitere Bereiche autauchen.
Der Index ist sensitiv und wenn Sie den Namen einer Funktion oder der Variablen auswäh-
len, führt der Hyperlink zu einer Detailbeschreibung. Dort werden Sie Informationen in-
den, in denen die verwendeten Token und der Quelltext selbst verwendet wurden, um eine
interaktive Dokumentation zu schafen.
Wenn sich Änderungen in den zu dokumentierenden Dateien ergeben, führen Sie jsdoc
einfach erneut aus und die Dokumentation wird überschrieben.
6.4.2■Automatische Kontrolle und Qualitätssicherung mit JSLint
Ein mächtiges Tool oder genauer ein Skript zur automatischen Kontrolle von JavaScript-
Code nennt sich JSLint ( http://www.jslint.com/ ). JSLint soll unabhängig von der internen
Arbeitsweise eines speziellen Browsers Programmierfehler und auch stilistische und quali-
tative Mängel in JavaScripts anzeigen und damit die Qualität des Codes erhöhen. Es geht
also neben der Suche nach echten Fehlern auch um eine explizite Prüfung, ob die strengen
Kodierungsregeln von JavaScript wirklich vollständig eingehalten werden, obwohl es mög-
licherweise gar keine sichtbaren Fehlerefekte in Testbrowsern gibt (weder in der Fehler-
konsole noch gegebenenfalls in einem Debugger).
Um so einen Qualitätssicherungstest auszuführen, können Sie auf der Webseite des Pro-
jekts einfach den Skriptcode in ein Formular einfügen und prüfen lassen.
Bild 6.5■ Der Code wurde von JSLint überprüt.
Search WWH ::




Custom Search