JSDoc
aus GlossarWiki, der Glossar-Datenbank der Fachhochschule Augsburg
Dieser Artikel erfüllt die GlossarWiki-Qualitätsanforderungen nur teilweise:
| Korrektheit: 5 (vollständig überprüft) |
Umfang: 2 (wichtige Fakten fehlen) |
Quellenangaben: 2 (wichtige Quellen fehlen) |
Quellenarten: 3 (gut) |
Konformität: 5 (ausgezeichnet) |
Definition
JSDoc ist eine Auszeichnungssprache, um eine API-Dokumentation inline (als spezielle JavaScript-Kommentare) in einen JavaScript-Code einzufügen.
Eigenschaften
Es gibt mehrere JSDoc-Tools, um aus JSDoc-Kommentaren automatisch eine API-Dokumentation in HTML oder Ähnlichem zu erstellen:
- JSDoc 3, JSDoc 3 (github)
- ADWiki
- Closure Linter (Bestandteil der Google Closure Tools)
JSDoc 3 hat sich zum De-facto-Standard entwickelt.
Die Erstellung von JSDoc-konformen Komentaren wird von einigen Entwicklungsumgebungen unterstützt:
- IntelliJ IDEA
- Visual Studio Code
- NetBeans
- RubyMine
- Eclipse (mit geeigneten Erweiterungen)
- Aptana Studio unterstützt ScriptDoc
Quellen
Alle weiteren Quellen wurden direkt im Artikel angegeben.
