JSDoc出力内のコメントの順序を維持する

Question

私はJavaScriptオブジェクトを持っています。パブリックメソッドがいくつか紹介されています。JSDocを使用してそれらをドキュメント化したいと思います。

私は、これらの機能をグループ化して順番に並べ替えていますが、JSDocを生成した後、すべてをアルファベット順に受け取ります。それはあまり意味がありません。

出力に順序を保持する方法はありますか？私は答えを見つけることができませんでしたが、私はそれが不可能であることも見いだせませんでした。

Answer 1

短い答え：偽、JSDocのは、アルファベット順のソートを使用するかどうかの並べ替えが低迷さ：あなたのconf.jsonファイル内

は、「並べ替え」のOPTS要素を追加します。

あなたはJSDocの設定オプションを指定するconf.jsonファイルを使用していると仮定します。たとえば

jsdoc -c path/to/conf.json 

：私もDocstrap、JSDoc3のためのブートストラップテンプレートに出くわした

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

。

テンプレートセクション内で 'sort'オプションを使用することができます。

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

Docstrapサイトからの説明は次のとおりです：trueに

ソートデフォルトとしてこの場合のconf.jsonファイルの例が表示される場合があります。 jsdocがデータをソートするか、ファイルの順序を使用するかどうかを指定します。文字列にすることもできます。もしそうなら、それはjsdocに直接渡されます。デフォルトの文字列は "longname、version、since"です。