Поиск по этому блогу

Показаны сообщения с ярлыком jsdoc. Показать все сообщения
Показаны сообщения с ярлыком jsdoc. Показать все сообщения

среда, 8 июня 2016 г.

Знакомимся с Node.js Style Guide и @use JSDoc

Должны же быть в nodejs соглашения о том, что и как писать в блоках комментариев. Да, и здесь есть еще теги (например @param {string} html), которые вставляются в блоки с многострочными комментариями... Оказывается, что так можно подготавливать документацию в процессе кодинга... Т.е., сначала пишешь комментарии в коде, а потом... можно все это "выпарсить" при помощи JSDoc в страницы с описанием API. Здесь видео и ссылки.