JSDoc: Unterschied zwischen den Versionen
aus GlossarWiki, der Glossar-Datenbank der Fachhochschule Augsburg
Kowa (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Kowa (Diskussion | Beiträge) |
||
| (4 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 7: | Zeile 7: | ||
}} | }} | ||
=Definition = | ==Definition == | ||
JSDoc ist eine Auszeichnungssprache, um eine [[API]]-Dokumentation inline (als spezielle [[JavaScript]]-Kommentare) in einen [[JavaScript-Code]] einzufügen. | JSDoc ist eine Auszeichnungssprache, um eine [[API]]-Dokumentation inline (als spezielle [[JavaScript]]-Kommentare) in einen [[JavaScript-Code]] einzufügen. | ||
=Eigenschaften= | ==Eigenschaften== | ||
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:// | * [http://usejsdoc.org/ JSDoc 3], [https://github.com/jsdoc3/ JSDoc 3 (github)] | ||
* [https://github.com/VlVl/adwiki ADWiki] | * [https://github.com/VlVl/adwiki ADWiki] | ||
* [https://developers.google.com/closure/utilities/ | * [https://developers.google.com/closure/utilities/ Closure Linter] (Bestandteil der [https://developers.google.com/closure/ Google Closure Tools]) | ||
Die Erstellung von JSDoc- | JSDoc 3 hat sich zum De-facto-Standard entwickelt. | ||
Die Erstellung von JSDoc-konformen Komentaren wird von einigen Entwicklungsumgebungen unterstützt: | |||
* [[IntelliJ IDEA]] | * [[IntelliJ IDEA]] | ||
* [[Visual Studio Code]] | |||
* [[NetBeans]] | * [[NetBeans]] | ||
* [[RubyMine]] | * [[RubyMine]] | ||
| Zeile 25: | Zeile 27: | ||
* [[Aptana Studio]] unterstützt '''ScriptDoc''' | * [[Aptana Studio]] unterstützt '''ScriptDoc''' | ||
=Quellen= | ==Quellen== | ||
#[[WikipediaEN:JSDoc|JsDoc (Wikipedia (en)]] | #[[WikipediaEN:JSDoc|JsDoc (Wikipedia (en)]] | ||
Alle weiteren Quellen wurden direkt im Artikel angegeben. | Alle weiteren Quellen wurden direkt im Artikel angegeben. | ||
=Siehe auch= | ==Siehe auch== | ||
# {{Vgl|JavaDoc}} | # {{Vgl|JavaDoc}} | ||
[[Kategorie: | [[Kategorie:JavaScript]] | ||
Aktuelle Version vom 29. November 2018, 12:38 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)
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.
