2013-12-18 1 views
7

У меня есть объект JavaScript, который вводит некоторые общедоступные методы, и я хочу использовать JSDoc для их документирования.JSDoc сохранить порядок комментариев на выходе

В исходном файле у меня есть эти функции, сгруппированные и упорядоченные в разумном порядке, но после генерации JSDoc я получаю все их в алфавитном порядке, что не имеет большого смысла.

Есть ли способ сохранить порядок в выходе? Я не мог найти ответа, но я также не мог найти, что это невозможно.

+1

Я не думаю, что это невозможно, но я ожидал бы, что с jsdoc 3.2.2 это было бы значительным начинанием. Я ожидаю, что минимальный размер, который вам нужно сделать, - создать собственный шаблон. Я основываю это на опыте, который у нас был с реорганизацией списка модулей и классов, помещенных в панель навигации: нам нужно было создать собственный шаблон. Я сомневаюсь, что методы переупорядочения будут проще. – Louis

+0

Спасибо, я думаю, я дам ему попробовать в будущем. Не так легко, как я ожидал, но все же может быть правдоподобным! –

ответ

1

Короткий ответ:

В файле conf.json добавьте OPTS элемент «своего рода»: ложные, где сорт слабеющий, следует ли использовать JSDoc алфавитную сортировку.

Предполагая, что вы используете файл conf.json назначить параметры конфигурации JSDoc:

jsdoc -c path/to/conf.json 

Например:

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

я наткнулся Docstrap, шаблон Bootstrap для JSDoc3.

Затем вы можете использовать опцию «сортировать» в разделе шаблонов. Пример conf.json файла для этого случая может выглядеть следующим образом:

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

Приведенные с сайта Docstrap является:

сортировать По умолчанию верно. Указывает, должен ли jsdoc сортировать данные или использовать порядок файлов. Может также быть строкой, и если она передается непосредственно в jsdoc. Строка по умолчанию - «longname, version, since».