Несколько месяцев назад я запустил и выпустил свой первый большой проект с открытым исходным кодом, инструмент документации для приложений Angular (https://medium.com/vincent-ogloblinsky/compodoc-documentation-tool-for-angular-2-applications- 44ec650e01a8 ).
Отзывы были очень хорошими, и идеи улучшений или ошибок очень быстро приходили в репозиторий Github.
В течение последних месяцев я работал над несколькими улучшениями, которые делают Compodoc очень интересной альтернативой TypeDoc для проектов Angular.
Вот некоторые подробности о большинстве из них:
График маршрутизации
Compodoc теперь поддерживает стандартные конфигурации маршрутизации Angular, например, с «модулями маршрутизации» и «отложенной загрузкой».
В демонстрационном проекте маршрутизации есть, например, один ленивый модуль и другие модули, которые загружаются непосредственно во время начальной загрузки приложения.
Это помогает очень быстро понять, какой компонент маршрутизируется, сколько маршрутов доступно, какой из них загружается лениво и т. Д.
Ограничения на данный момент заключаются в поддержке переменных в определениях массивов маршрутов. Скоро это будет исправлено.
const APP_ROUTES: Routes = [...ROUTES];Смотреть флаг
Во время документирования проекта очень полезно обновлять динамическую документацию с последними деталями, написанными разработчиком.
В Compodoc появилась функция «смотреть». Просто запустите инструмент с флагом -w и позвольте волшебству случиться.
Дополнительная документация
Расширение созданной документации также интересно тем, что предоставляет дополнительную информацию об основных функциях приложения.
В версии 1 вы можете предоставить файлы уценки, расположенные в отдельном каталоге, и в меню появится специальная запись.
compodoc в @ compodoc / compodoc
Я переместил compodoc в пакет с ограниченной областью видимости, а также другие связанные проекты, такие как ngd от Вассима Чегама.
Итак, теперь для установки вам просто нужно использовать область @compodoc:
npm i @compodoc/compodoc --save-dev or -g
Веб-сайт
Я также создаю специальный веб-сайт для размещения документации более простым способом, чем простой файл README на github.
Что дальше ?
Дорожная карта на месяцы тритона посвящена:
- обрабатывать проекты AngularJS 1.6.x с помощью TypeScript
- переместить График модулей со статического изображения на график svg, можно использовать vis.js
- поддержка более общего синтаксиса TypeScript / ES6
Мы ценим ваши отзывы. Пожалуйста, открывайте любую проблему, с которой вы можете столкнуться, и запросы на включение более чем приветствуются.
Следите за обновлениями Винсента Оглоблинского / @vogloblinsky.
