Какво е Compodoc? Страхотна библиотека на трета страна, която автоматично генерира статична документация въз основа на кода с една команда.
Като разработчик пиша много код, но се фокусирам по-малко върху документирането на приложението. Ако сте като мен, тук е страхотната библиотека на трети страни за документация — Compodoc.
Compodoc е страхотен инструмент за документиране. Той автоматично генерира статична документация въз основа на кода с една команда.
Сега нека видим как можем да използваме Compodoc в Angular приложение.
Първо, нека създадем ново ъглово приложение с CLI.
ng new angular-compodocСлед като CLI приключи със създаването на приложението, стартирайте ng serve и се уверете, че можете да видите приложението на localhost:4200
Сега нека инсталираме Compodoc глобално и да го добавим към вашия локален проект. Можете да го инсталирате ръчно, но командите по-долу ще улеснят работата ви.
npm install -g @compodoc/compodoc
ng add @compodoc/compodocГорната команда ще добави всички зависимости, скриптове и файлове tsconfig.doc.json, необходими за стартирането на Compodoc.
Вече сте готови да използвате възможностите за документация за вашия ъглов проект. Изпълнете командата по-долу и отворете http://127.0.0.1:8080/ в избрания от вас браузър.
npm run compodoc:build-and-serve
Последвайте ме в Medium или Twitter, за да прочетете повече за Angular и JavaScript!
Повече съдържание на PlainEnglish.io. Регистрирайте се за нашия безплатен седмичен бюлетин. Следвайте ни в Twitter и LinkedIn. Присъединете се към нашата общност Discord.
