Take it easy JavaScript: JavaScript von einfach bis komplex

tieJS-Tutorial: Das Documentation-Plug-in
Keine Kommentare

Anfänger brauchen nicht immer den vollen Umfang komplexer IDE-Features. Genau an diese Zielgruppe richtet sich tieJS: Der JavaScript-Editor bringt in der Grundversion nur die wichtigsten Funktionen mit, kann aber erweitert werden. Wer beispielsweise eine Dokumentation schreiben möchte, kann dafür das entsprechende Plug-in nutzen.

Die frei verfügbare Software tieJS ist eine Entwicklungsumgebung für die Programmierung mit JavaScript. Die Grundversion enthält nur die wichtigsten Funktionen, damit die Bedienung einfach bleibt. Durch Plug-ins kann die Funktionalität des Editors erweitert werden.

Die Plug-ins können unter https://ilernen.eu/tieJS/#idpluginlist als zip-Datei heruntergeladen werden. Das hier betrachtete Documentation-Plug-in wird dazu verwendet den eigenen Quellcode zu dokumentieren. Durch das Plug-in wird das Modul documentation.js (siehe http://documentation.js.org/) in tieJS integriert und per Knopfdruck nutzbar gemacht.

Die heruntergeladene Zip-Datei wird in den Ordner tieJS\bin\plugins des tieJS-Installationsverzeichnisses extrahiert und steht nach Programmstart im Tools-Tab zur Verfügung.

Die Dokumentation erfolgt im eigenen Quelltext sofort während der Programmierung, indem beispielsweise vor einer Funktion durch einen geeignet formatierten Kommentar die Informationen zur Dokumentation der Funktion hinzugefügt werden:

Die Kommentare werden in der JSDoc-Syntax angegeben. Bei den JS-Snippets steht nach Installation des Plug-ins ein entsprechendes documentation-Snippet zum Einfügen in den eigenen Quelltext mit den wichtigsten Angaben zur Dokumentation einer Funktion zur Verfügung. Weitere Informationen zur JSDoc-Syntax findet man unter https://jsdoc.app/ und http://documentation.js.org/.

Durch Klick auf den Documentation-Button im Tools-Tab wird die Dokumentation als HTML-Datei generiert und angezeigt:

Die HTML-Datei wird im Unterordner doc_tieJS/index.html der betrachteten Quelltextdatei math.js abgespeichert:

Im nächsten Teil dieser Artikelreihe schauen wir uns an, wie man mithilfe des Jasmine-Plug-ins einfache Unit-Tests für den eigenen Quelltext erstellen und durchführen kann.

Unsere Redaktion empfiehlt:

Relevante Beiträge

Hinterlasse einen Kommentar

Hinterlasse den ersten Kommentar!

avatar
400
  Subscribe  
Benachrichtige mich zu:
X
- Gib Deinen Standort ein -
- or -