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

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

Node.js Style Guide This is a guide for writing consistent and aesthetically pleasing node.js code. It is inspired by what is popular within the community, and flavored with some personal opinions.
nodeschool.io Воркшопы Это оффлайн семинары, зачастую бесплатные, на которых менторы помогают участникам проходить задания учебной программы workshoppers
Исходники и документация для Node.JS
@use JSDoc In addition, JSDoc recognizes the conventions of Node.js modules, which extend the CommonJS standard (for example, assigning a value to module.exports). Depending on the coding conventions you follow, you may need to provide some additional tags to help JSDoc understand your code.

In [ ]:

####Вот пример из предыдущего поста

In [ ]:

/**
 * Returns unique CSS class names from html string in source file order.
 * @param {string} html
 * @returns {string[]} class names
 */

На usejsdoc.org находим¶

The @param tag provides the name, type, and description of a function parameter.

The @param tag requires you to specify the name of the parameter you are documenting. You can also include the parameter's type, enclosed in curly brackets, and a description of the parameter.

The @returns tag documents the value that a function returns.

In [ ]:

/**
 * Returns the sum of a and b
 * @param {Number} a
 * @param {Number} b
 * @returns {Number}
 */
function sum(a, b) { 
    return a + b;
}

Посты чуть ниже также могут вас заинтересовать