Как написать документацию моих функций в угловых

Question

Я хочу написать документацию моего Angular проекта. Кто-нибудь может подсказать мне, как по умолчанию писать документацию для Angular? Я искал это онлайн, но не мог найти никакого ответа. Все, что я нашел, это что-то, связанное с compodoc. Но я хочу задокументировать каждую функцию моего проекта.

Answer 1

Если вы создаете проект AngularJS (1.x): Многие разработчики JavaScript используют JSDoc для документирования своего кода (http://usejsdoc.org/).

Если вы строите угловой проект (2+): Microsoft выпустила стандарт для проектов машинописного текста: https://github.com/Microsoft/tsdoc