Dies ist der Befehl jsdoc, der beim kostenlosen Hosting-Anbieter OnWorks mit einer unserer zahlreichen kostenlosen Online-Workstations wie Ubuntu Online, Fedora Online, dem Windows-Online-Emulator oder dem MAC OS-Online-Emulator ausgeführt werden kann
PROGRAMM:
NAME/FUNKTION
jsdoc – automatischer Generator für die HTML-Dokumentation von Javascript-Quellen
ZUSAMMENFASSUNG
jsdoc {-d= | --Verzeichnis=} [Optionen] ...
jsdoc [{-h | --help}]
BESCHREIBUNG
Diese Handbuchseite dokumentiert kurz die jsdoc Befehl.
jsdoc ist eine in JavaScript geschriebene Anwendung zur automatischen Generierung
Vorlagenformatierte, mehrseitige HTML-Dokumentation (oder XML, JSON oder eine andere textbasierte Dokumentation).
aus kommentiertem JavaScript-Quellcode.
OPTIONAL
Das Programm folgt der üblichen GNU-Befehlszeilensyntax, mit langen Optionen, die mit zwei beginnen
Bindestriche (`-'). Nachfolgend finden Sie eine Zusammenfassung der Optionen. Eine vollständige Beschreibung finden Sie im
Info(1) Dateien.
-a, --allfunction
Beziehen Sie alle Funktionen ein, auch nicht dokumentierte.
-c, --conf
Laden Sie eine Konfigurationsdatei.
-d=, --Verzeichnis=
Ausgabe in dieses Verzeichnis (erforderlicher Parameter).
-D="myVar:My Wert", --define="myVar:My Wert"
Mehrere. Definieren Sie eine Variable, die in JsDoc als JSDOC.opt.D.myVar verfügbar ist.
-e=, --encoding=
Verwenden Sie diese Kodierung zum Lesen und Schreiben von Dateien.
-E=„REGEX“, --ausschließen=„REGEX“
Mehrere. Schließen Sie Dateien basierend auf dem bereitgestellten regulären Ausdruck aus.
-h, --help
Diese Nachricht anzeigen und beenden.
-m, --multiples
Warnen Sie nicht davor, dass Symbole mehr als einmal dokumentiert werden.
-n, --kein Code
Ignorieren Sie den gesamten Code und dokumentieren Sie nur Kommentare mit @name-Tags.
-o=, --out=
Protokollmeldungen in eine Datei drucken (standardmäßig stdout).
-p, --Privatgelände
Fügen Sie Symbole ein, die als private, unterstrichene und innere Symbole gekennzeichnet sind.
-q, --ruhig
Geben Sie keine Meldungen aus, auch keine Warnungen.
-r=, --recurse=
Steigen Sie in src-Verzeichnisse ab.
-s, --unterdrücken
Quellcodeausgabe unterdrücken.
-S, --securemodules
Verwenden Sie den Secure Modules-Modus, um den Quellcode zu analysieren.
-t=, --Vorlage=
Verwenden Sie diese Vorlage, um die Ausgabe zu formatieren.
-T, --Prüfung
Führen Sie alle Komponententests aus und beenden Sie den Vorgang.
-u, --einzigartig
Erzwingen Sie, dass Dateinamen eindeutig sind, aber nicht auf Symbolnamen basieren.
-v, - ausführlich
Geben Sie ausführliches Feedback zum Geschehen.
-x=[,EXT]..., --ext=[,EXT]...
Quelldateien mit der/den angegebenen Erweiterung(en) scannen (standardmäßig js).
Verwenden Sie jsdoc online über die Dienste von onworks.net
