9 февраля 2022
Владимир Андреев в интервью для ТВ-канала «ПРО БИЗНЕС» рассказал о секретах успешного ИТ-бизнеса в России и трендах софтверной индустрии.
Вжух и готово — генерируем документацию из TypeScript кода с Typedoc
- 8 ноября 2017
- Публикации в СМИ о СЭД Docsvision
В этой статье наш коллега рассказывает, как мы генерируем документацию из комментариев в коде TypeScript.
«Typedoc пока довольно сырой проект, и мне не удалось найти достойных альтернатив», - пишет Павел. «Удивительно, что эта тема так слабо развита, учитывая что TypeScript все больше набирает популярность. Этой статьей я хотел бы привлечь внимание сообщества к этой теме и к typedoc в частности. Проект остро нуждается в контрибьюторах, нужно развивать утилиту, писать классные темы, актуализировать документацию. Генерация документации из кода — это мегаполезная вещь и хорошего API Reference очень не хватает многим javascript-библиотекам. Можно с уверенностью сказать, что typedoc — рабочий инструмент, который справляется со своей задачей и достаточно гибок, чтобы удовлетворить большинству потребностей. У нас довольно большой проект, и никаких особых проблем в его работе мы пока не обнаружили. Код разбирается корректно, ничего не падает и работает хорошо.
Единственное, чего ему не хватает — внимания от сообщества. Используйте в своих проектах и делитесь своими наработками. Нашу тему можно скачать на github».