2013-12-18 5 views
7

Ich habe ein JavaScript-Objekt, das einige öffentliche Methoden einführt, und ich möchte JSDoc verwenden, um sie zu dokumentieren.JSDoc Reihenfolge der Kommentare in der Ausgabe beibehalten

In der Quelldatei habe ich diese Funktionen gruppiert und geordnet in einer angemessenen Reihenfolge, aber nach dem Generieren von JSDoc ich alle in alphabetischer Reihenfolge erhalten, das macht nicht viel Sinn.

Gibt es eine Möglichkeit, die Reihenfolge in der Ausgabe zu halten? Ich konnte keine Antwort finden, aber ich konnte auch nicht finden, dass es unmöglich ist.

+1

Ich glaube nicht, dass es unmöglich ist, aber ich würde erwarten, dass mit Jsdoc 3.2.2 wäre es ein bedeutendes Unterfangen. Ich würde erwarten, dass Sie nur eine benutzerdefinierte Vorlage erstellen müssen. Ich stütze mich dabei auf die Erfahrung, die wir mit der Neuorganisation der Liste der Module und Klassen in der Navigationsleiste hatten: Wir mussten unsere eigene Vorlage erstellen. Ich bezweifle, dass das Umordnen einfacher wäre. – Louis

+0

Danke, ich denke, ich werde es in Zukunft versuchen. Nicht so einfach, wie ich es erwartet habe, aber trotzdem möglich! –

Antwort

1

Die kurze Antwort: false, wo sortieren Markieren, ob JSDoc alphabetische Sortierung verwendet werden soll:

Innerhalb Ihrer conf.json Datei, ein opts Element "sortieren" hinzufügen.

Vorausgesetzt Sie haben eine conf.json Datei verwenden, um Ihre JSDOC Konfigurationsoptionen zu bezeichnen:

jsdoc -c path/to/conf.json 

Zum Beispiel:

{ 
    "tags": { 
     "allowUnknownTags": false 
    }, 
    "source": { 
     "includePattern": ".+\\.js(doc)?$", 
     "excludePattern": "(^|\\/|\\\\)_" 
    }, 
    "plugins": [], 
    "templates": { 
     "cleverLinks": true, 
     "monospaceLinks": false, 
    }, 
    "opts": { 
     "encoding": "utf8", 
     "lenient": false, 
     "sort": false 
    } 
} 

ich über Docstrap auch kam, eine Bootstrap-Vorlage für JSDoc3.

Sie können dann die Option 'sort' innerhalb des Vorlagenbereichs verwenden. Beispiel einer conf.json Datei für diesen Fall könnte wie folgt aussehen:

{ 
    "tags": { 
     "allowUnknownTags": true, 
     "dictionaries": ["jsdoc","closure"] 
    }, 
    "source": { 
     "includePattern": ".+\\.js(doc|x)?$", 
     "excludePattern": "(^|\\/|\\\\)_" 
    }, 
    "plugins": [], 
    "templates": { 
     "cleverLinks": false, 
     "monospaceLinks": false 
     "sort": false 
    } 
} 

Die Beschreibung der Docstrap bestimmten Standort ist:

Art Defaults auf true. Gibt an, ob jsdoc Daten sortieren oder die Dateireihenfolge verwenden soll. Kann auch eine Zeichenkette sein und wird dann direkt an jsdoc übergeben. Der Standard-String ist "longname, version, da".