DocumentJS arbeitet über die Node.js Befehlszeile und ermöglicht es Entwicklern, Dokumentation Websites zu erstellen, ohne eine doppelte lästigem Schreiben von Kommentaren in ihrem Code zu tun haben, und erklären sie dann später in ein separate HTML-Datei.
Die Dokumentation Seite ist der Quellcode erstellt, kommentiert selbst, die alle automatisch, wenn die Entwickler einfachen Code Kommentare Formatierungsregeln folgen.
DocumentJS unterstützt einfache Strukturen und Markdown-Syntax, zusammen mit der Fähigkeit versioniert Dokumentation zu erstellen, arbeiten synchron mit der Versionskontrolle Geschichte Code.
Wenn der Code von Kommentaren in Ihre Quelle zu viel Platz in Anspruch nehmen, können sie in eine separate Datei exportiert werden Markdown und dann auf den ursprünglichen Code mit einfachen Markierungen gebunden zurück.
Dieses letztere Merkmal für größere Projekte große Arbeiten, in denen mehr als eine Person auf dem Code funktioniert und tiefer gehende Details werden für jede Funktion, Methode oder Parameter benötigt werden.
.
DocumentJS & nbsp; entwickelt wurde ein Teil des JavaScript-Framework zu sein - JavaScriptMVC
Funktionen :
- Flexible Organisation Ihrer Dokumentation
- Eine integrierte Dokumentation Betrachter, wo Sie Ihre API suchen
- Unterstützung Markdown
- Eine erweiterbare Architektur
Kommentare nicht gefunden