YUIDoc ist das offizielle Dokumentationsgenerator von der Yahoo! Team für die Yahoo verwendet! User Interface 3.x (YUI) Serie.
Die App funktioniert durch Scannen JavaScript-Code für die Kommentare, und sie als Dokumentation für den Code selbst.
YUIDoc kann verwendet werden, um Informationen über die Eigenschaften, benutzerdefinierte Ereignisse, Methoden und Vererbung für JS-Objekte dokumentieren werden.
Neben der Erzeugung von Dokumentation Sites von JavaScript-Code, kommt YUIDoc auch mit einem integrierten Web-Server als auch. Dieses Feature wurde enthalten, damit Entwickler Dokumentation Websites in Echtzeit-Vorschau, während sie ihren Code und Kommentare schreiben zu können.
Doc , auf ähnliche Dokumentationsgenerator von Yahoo, vor allem in Python, aber geschrieben
Was ist neu; YUIDoc sollte nicht mit YUI & nbsp verwechselt werden. in dieser Pressemitteilung:.
Was ist neu in der Version 0.7.0:
- Fixed:
- Wechseln Sie zu wahren Markdown-Optionen als Standard
- Ein Fehler, der Klasse geerbt wurde zweimal analysiert Fix
- Unindent Verfahren Lenker Teiltöne im Konstruktor Klassen
- Verwenden logFn Konfiguration Anmeldung
- Geändert:
- Tropfen entfernt JSHint Regeln
Was ist neu in der Version 0.6.0:
- Geändert:
- Der Markdown Markdown-Parser, um es
- In Node.js v0.12 und io.js in Travis CI Einstellung
- Fixed:
- Ein Fehler mit & quot; @ & rdquo; hat im Beispiel nicht escapable
Was ist neu in der Version 0.5.0:
- YUIDoc unterstützt @ throws-Tag schließlich, und es enthält mehr Kompatibilität mit Lenker v2.0, Verbesserungen und Abhängigkeiten Updates.
Was ist neu in der Version 0.4.0:
- Unterstützt ES6 Stil übrigen Parameter Syntax für mehrere Parameter
- Ermöglicht Basis-URLs für externe Links
- Fügt --no-sort-Option
Was ist neu in Version 0.3.49:.
- Geänderte URL Schöpfung, einfach anzuschließen Strings
Was ist neu in Version 0.3.47:
- Ändern Fusseln: Erfolgreiche lint verlässt den CLI, nicht erfolgreich lint beendet den Vorgang.
- lint ändern, so dass Prozess beendet wird nur im Fehlerfall.
Anforderungen :
- Node.js 0.4 oder höher
Kommentare nicht gefunden