Nach dem Ausführen eines grundlegenden JSDoc-Kompilier- / Rendervorgangs von Node.js:

jsdoc file1.js file2.js

Ich erhalte ein gut formatiertes Dokument mit der Standardvorlage in einem Verzeichnis "out". Fast alles ist wie erwartet!

Aber beim Öffnen des Dokuments wird auf der index.html-Seite immer "Home" angezeigt, es enthält keinen Inhalt auf der Startseite und in der Seitenleistennavigation "Home".

Wie und wo notiere ich den Namen des Projekts, sodass er "Home" ersetzt? Ich möchte auch eine Projektbeschreibung sowie Informationen zum Autor und zum Urheberrecht erhalten.

Es scheint die grundlegendste Aufgabe in einem JSDoc zu sein, aber ich kann die Informationen nicht finden! Ich habe Folgendes versucht, basierend auf einem zufälligen Artikel, den ich im Internet gefunden habe:

/** 
 * This JavaScript file contains foo bar baz...
 * 
 * @projectname Project Name
 * @version 0.1
 * @author Greg Pettit
 * @copyright 2015
 * 
 */

Aber ich bekomme keine Liebe.

[bearbeitet, um hinzuzufügen:]

Entdeckte die Direktive @file / @fileOverview / @overview (alle Synonyme), die etwas hilfreich ist, da ich jetzt Copyright- / Autoreninformationen für jede Datei beschreiben und festlegen kann:

/** 
 * @file Project description which renders below the individual filename and therefore isn't a real overview blurb.
 * 
 * @version 0.1
 * @author Greg Pettit
 * @copyright 2015
 * 
 */

Das lässt 2 "Probleme" noch zu lösen:

Eine Übersichtsbeschreibung; Ich denke, @file kümmert sich um die meisten meiner Bedürfnisse, aber da es sich um eine Datei handelt, möchte ich immer noch einen Absatz vom Typ "Einführung" oder einen Übersichtsabsatz, der vor den Beschreibungen der enthaltenen Dateien erscheint.

Ersetzen Sie diesen "Home" -Text mit benutzerdefiniertem Text