jsdoc — широко используемый инструмент для автоматического создания документации. Пока мы пишем комментарии в соответствии с синтаксисом jsdoc, мы можем успешно сгенерировать очень красивый документ.
Просто jsdoc дляjsфайл, для.vueФайл кажется немного беспомощным. Но с тех порvueНастолько популярный, я думаю, что будут соответствующие инструменты. После поиска вокруг я нашел один, написанный старшим.jsdoc-vue.
После небольшого исследования я обнаружил, что этот инструмент в основном решает проблему нераспознанного jsdoc..vueпроблема с файлом. Хотя это может быть.vueФайл автоматически создает документацию, но стиль сгенерированной документации выглядит некрасиво. Поэтому я разветвил его и изменил.
Без лишних слов, давайте сначала сделаем скриншот сгенерированного документа. адрес гитхаба:Модернизация jsdoc-vue
Основные части ремонта следующие:
- использовал
jsdocсловарь, так что вы можете использоватьjsdocПоставляется с тегами для записи. Это также облегчает создание необходимых шаблонов. - Создание документации с помощьюminamiшаблон
- Обновлены модули vue-template-complier и jsdoc.
Как установить и использовать
git clone git@github.com:Konata9/jsdoc-vue.git
npm install
Я вполне доволен этой модифицированной версией, но более важными вещами являются:propsа такжеcomponentsКомпоненты могут быть четко выражены с использованием синтаксиса, поставляемого с jsdoc.
Если вам это нравится, я надеюсь, что вы можете нажать на звезду. Конечно, если есть возможности для улучшения, надеюсь, вы подскажете.