JSDoc

aus GlossarWiki, der Glossar-Datenbank der Fachhochschule Augsburg
Wechseln zu:Navigation, Suche

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)

1 Definition

JSDoc ist eine Auszeichnungssprache, um eine API-Dokumentation inline (als spezielle JavaScript-Kommentare) in einen JavaScript-Code einzufügen.

2 Eigenschaften

Es gibt mehrere JSDoc-Tools, um aus JSDoc-Kommentaren automatisch eine API-Dokumentation in HTML oder Ähnlichem zu erstellen:

JSDoc 3 hat sich zum De-facto-Standard entwickelt.

Die Erstellung von JSDoc-konformen Komentaren wird von einigen Entwicklungsumgebungen unterstützt:

3 Quellen

  1. JsDoc (Wikipedia (en)

Alle weiteren Quellen wurden direkt im Artikel angegeben.

4 Siehe auch

  1. JavaDoc