Заказать демо

Вжух и готово — генерируем документацию из TypeScript кода с Typedoc

В этой статье наш коллега рассказывает, как мы генерируем документацию из комментариев в коде TypeScript. 

«Typedoc пока довольно сырой проект, и мне не удалось найти достойных альтернатив», - пишет Павел. «Удивительно, что эта тема так слабо развита, учитывая что TypeScript все больше набирает популярность. Этой статьей я хотел бы привлечь внимание сообщества к этой теме и к typedoc в частности. Проект остро нуждается в контрибьюторах, нужно развивать утилиту, писать классные темы, актуализировать документацию. Генерация документации из кода — это мегаполезная вещь и хорошего API Reference очень не хватает многим javascript-библиотекам. Можно с уверенностью сказать, что typedoc — рабочий инструмент, который справляется со своей задачей и достаточно гибок, чтобы удовлетворить большинству потребностей. У нас довольно большой проект, и никаких особых проблем в его работе мы пока не обнаружили. Код разбирается корректно, ничего не падает и работает хорошо. 

Единственное, чего ему не хватает — внимания от сообщества. Используйте в своих проектах и делитесь своими наработками. Нашу тему можно скачать на github».

Похожие публикации
6 ноября 2018
Президент «ДоксВижн» в интервью TAdviser рассказывает о новых потребностях корпоративных заказчиков, изменениях систем электронного документооборота, а также инновациях, которые проникают в эту сферу. Интервью войдёт в ежегодный обзор портала TAdviser по рынку СЭД/ECM.
8 октября 2018
Участники конференции «ИКТ в госсекторе 2018: цифровое будущее» от CNews Conferences обсудили, как наиболее эффективно использовать информационные системы в новой цифровой среде.
Подпишитесь на рассылку
Заполняя настоящую форму, Вы подтверждаете свое полное согласие на обработку Ваших персональных данных, в соответствии с Федеральным законом от 27.07.2006 г. № 152-ФЗ "О персональных данных". Обработка персональных данных ООО «ДоксВижн» осуществляется в соответствии Политикой ООО «ДоксВижн» в отношении обработки персональных данных, в которой также содержатся сведения о реализуемых требованиях к защите персональных данных