ДЕМОЦЕНТР

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

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

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

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

Похожие публикации
27 августа 2019
Компании вправе отказаться от оформления и хранения подавляющего большинства документов на «бумаге». Но для полной цифровизации руководителю придется преодолеть скепсис не только сотрудников, но и партнеров. На деловом завтраке в Санкт-Петербурге, который провела газета «Деловой Петербург», обсудили все нюансы перехода на ЭДО. Владимир Андреев, президент «ДоксВижн», был одним из спикеров.
21 августа 2019
Инструменты для управления проектами становятся все более востребованным функционалом в составе СЭД. Мы и наши коллеги-разработчики систем беседуют о соответствующих модулях в СЭД и интеграционных решениях, о наиболее заинтересованных пользователях, собственном опыте и прогнозах развития тренда на страницах ICT-Online.ru.
Подпишитесь на рассылку
Нажимая на кнопку «Отправить», вы даете согласие на обработку ваших персональных данных, в соответствии с политикой «ДоксВижн» в отношении обработки персональных данных.