#angular #documentation
#angular #Документация
Вопрос:
Я хочу написать документацию моего проекта Angular. Кто-нибудь может подсказать мне, каков способ написания документации по умолчанию для Angular? Я искал ее в Интернете, но не смог найти никакого ответа. Все, что я нашел, связано с compodoc
. Но я хочу документировать каждую функцию моего проекта.
Ответ №1:
Если вы создаете проект AngularJS (1.x): Многие разработчики javascript используют JSDoc как способ документирования своего кода (http://usejsdoc.org /).
Если вы создаете проект Angular (2 ): Microsoft выпустила стандарт для проектов typescript:https://github.com/Microsoft/tsdoc