Какой самый простой способ заставить JsDoc оставить ссылки источника? Должен ли я определять свой собственный шаблон?Как я могу опустить исходные ссылки в JsDoc?
ответ
Если вы используете шаблон по умолчанию, используйте файл конфигурации с templates.default.outputSourceFiles
, установленный на false
. Например:
{
"templates": {
"default": {
"outputSourceFiles": false
}
}
}
Вы бы пройти путь к этому файлу в JSDoc используя -c
опцию в командной строке.
Я не вижу этот вариант, задокументированный в любой реальной документации jsdoc. Я нашел это в this issue и this one.
Шаблон - это объект, предоставляющий эту функциональность, поэтому, если вы используете другой шаблон, отличный от стандартного, вы должны проверить его документацию, чтобы определить, есть ли параметр, который вы можете установить для этого.
Для завершения вам может понадобиться установить оба «outputSourceFiles»: ложь, «outputSourcePath»: ложные, как прочитанный на https://github.com/terryweiss/docstrap#configuring-the-template – Chris
@ Крис Это true, если вы используете Docstrap, и это связано с моим последним абзацем об использовании шаблонов, отличных от стандартного. Я только что опубликовал последний стабильный выпуск jsdoc для 'outputSourcePath' и его нигде не найти. – Louis
downvote, если вы хотите, пожалуйста, прокомментировать почему? – jlarson