JSDoc

JSDoc können die Dokumentation in einer breiten Reihe von textbasierten Formaten wie HTML, XML, JSON, und so weiter zu produzieren.

JSDoc vorher wissen, wie JSDoc Toolkit.

Die ehemaligen JSDoc Versionen Java, um den Quellcode zu analysieren, zu extrahieren Kommentare und erzeugen die Dokumentation. Seit der 3.x-Zweig Node.js wird stattdessen verwendet.

Neben Node.js, JSDoc kann auch mit Mozilla Rhino Engine so gut funktionieren.

Um JSDoc richtig zu nutzen, überprüfen Sie die Dokumentation für Informationen darüber, wie Sie Ihren Quellcode Kommentare zu formatieren, damit sie erkannt und durch JSDoc des Motors verwendet werden können.

Was ist neu in dieser Pressemitteilung:.

• können nun JSDoc auf Node.js
• können nun die @ Interface undimplements Tags zu Schnittstellen und deren Umsetzungen zu dokumentieren.
• Closure Compiler istinheritDoc undOverride Tags werden jetzt unterstützt.
• Wenn die JSDoc Kommentar für ein Symbol enthält diemixes tag, alle Mixins jetzt in der Dokumentation des Symbols angezeigt.
• JSDoc kann nun Protokollinformationen auf der Konsole, wie es läuft (beispielsweise der Name jeder Datei, die JSDoc analysiert). Um diese Informationen, führen JSDoc mit der --verbose flag einloggen.
• Kann jetzt eine beliebige Datei als Paket oder Readme-Datei für Ihre Unterlagen zu verwenden. Verwenden Sie die -P / - Paket / und -R / -. Readme-Flags, um das Paket und Readme-Datei angeben
• Typografie und Farbschema der Standard-Vorlage wurden deutlich verbessert.

Was ist neu in der Version 3.3.2:

• können nun JSDoc auf Node.js.
• können nun die @ Interface undimplements Tags zu Schnittstellen und deren Umsetzungen zu dokumentieren.
• Closure Compiler istinheritDoc undOverride Tags werden jetzt unterstützt.
• Wenn die JSDoc Kommentar für ein Symbol enthält diemixes tag, alle Mixins jetzt in der Dokumentation des Symbols angezeigt.
• JSDoc kann nun Protokollinformationen auf der Konsole, wie es läuft (beispielsweise der Name jeder Datei, die JSDoc analysiert). Um diese Informationen, führen JSDoc mit der --verbose flag einloggen.
• Kann jetzt eine beliebige Datei als Paket oder Readme-Datei für Ihre Unterlagen zu verwenden. Verwenden Sie die -P / - Paket / und -R / -. Readme-Flags, um das Paket und Readme-Datei angeben
• Typografie und Farbschema der Standard-Vorlage wurden deutlich verbessert.

Was ist neu in Version 3.3.0:

• können nun JSDoc auf Node.js.
• können nun die @ Interface undimplements Tags zu Schnittstellen und deren Umsetzungen zu dokumentieren.
• Closure Compiler istinheritDoc undOverride Tags werden jetzt unterstützt.
• Wenn die JSDoc Kommentar für ein Symbol enthält diemixes tag, alle Mixins jetzt in der Dokumentation des Symbols angezeigt.
• JSDoc kann nun Protokollinformationen auf der Konsole, wie es läuft (beispielsweise der Name jeder Datei, die JSDoc analysiert). Um diese Informationen, führen JSDoc mit der --verbose flag einloggen.
• Kann jetzt eine beliebige Datei als Paket oder Readme-Datei für Ihre Unterlagen zu verwenden. Verwenden Sie die -P / - Paket / und -R / -. Readme-Flags, um das Paket und Readme-Datei angeben
• Typografie und Farbschema der Standard-Vorlage wurden deutlich verbessert.

Was ist neu in der Version 3.2.2 / 3.3.0-beta1:

• Adressiert eine Regression in JSDoc 3.2.1, die eine Funktionsdeklaration von Spiegeln einer Erklärung mit dem gleichen Namen in einem äußeren Umfang verhindern können.
• Wenn ein Kind-Klasse überschreibt eine Methode in einer übergeordneten Klasse ohne Dokumentation der überschriebenen Methode, die Dokumentation der Methode wird nun von der übergeordneten Klasse kopiert.
• Sie können nun in Markdown-formatierten Text verwenden Inline-HTML-Tags. Darüber hinaus nutzt JSDoc jetzt nur die markierte Markdown-Parser; der Abschlag-js-Parser wurde entfernt.
• Geben Sie Ausdrücke können nun eine viel breitere Palette von wiederholbaren Typen. Darüber hinaus können Sie nun mit Nullable-und Nicht-Nullable-Modifikatoren Closure Compiler mit wiederholbaren Typen. Zum Beispiel wird der Ausdruck des Typs ...! String (eine wiederholbare, Nicht-Nullable String) jetzt korrekt analysiert.

Was ist neu in der Version 2.4.0:

• Ein Fehler wurde behoben, der mutiple Symbole mit dem gleichen Namen hinzugefügt um docs.
• Unterstützung für die Option -m, um Warnungen für mehrere Dokumente zu unterdrücken aufgenommen.
• Patch von brownsea42 Hinzu zitiert Benutzervariablen auf der Kommandozeile zu unterstützen.
• Ein Fehler wurde behoben, der manchmal dazu führte, Links zu Veranstaltungen, um falsch sein.

Anforderungen :

• JavaScript auf Clientseite aktivieren
• Node.js 0.10 oder höher