JSDoc: Unterschied zwischen den Versionen
aus GlossarWiki, der Glossar-Datenbank der Fachhochschule Augsburg
Kowa (Diskussion | Beiträge) |
Kowa (Diskussion | Beiträge) |
||
| Zeile 13: | Zeile 13: | ||
Es gibt mehrere JSDoc-Tools, um aus JSDoc-Kommentaren automatisch eine [[API]]-Dokumentation in [[HTML]] oder Ähnlichem zu erstellen: | Es gibt mehrere JSDoc-Tools, um aus JSDoc-Kommentaren automatisch eine [[API]]-Dokumentation in [[HTML]] oder Ähnlichem zu erstellen: | ||
* [http://usejsdoc.org/ JSDoc 3], [https://github.com/jsdoc3/ JSDoc 3 (github)] | * [http://usejsdoc.org/ JSDoc 3], [https://github.com/jsdoc3/ JSDoc 3 (github)] | ||
* [https://github.com/VlVl/adwiki ADWiki] | * [https://github.com/VlVl/adwiki ADWiki] | ||
Version vom 29. November 2018, 12:35 Uhr
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)
Die Erstellung von JSDoc-Konformen Komentaren wird von einigen Entwicklungsumgebungen unterstützt:
- IntelliJ IDEA
- NetBeans
- RubyMine
- Eclipse (mit geeigneten Erweiterungen)
- Aptana Studio unterstützt ScriptDoc
Quellen
Alle weiteren Quellen wurden direkt im Artikel angegeben.
