goldis
6/19/2019 - 6:27 AM

JsDoc

/**
  * Складываем числа
  * 
  * @param {number} first - первое число
  * @param {number} second - второе число
  * @returns {number}
  */
 function add(first, second) {
    return first + second;
}


// Documentation.js
// После того, как ваша база кода достаточно задокументирована, пришло время обратиться к инструменту, который поможет создать документацию на основе всех замечательных комментариев, которые вы только что написали. В студии 4thought мы используем фантастический проект Documentation.js, но есть несколько других вариантов. Все эти проекты делают одно и то же — они переписывают ваши тщательно написанные комментарии кода JSDoc в читаемую документацию html или markdown.
// Documentation.js — это node-пакет, предназначенный для анализа JSDoc и вывода документации в нескольких разных форматах. Мы используем Markdown, чтобы иметь возможность напрямую ссылаться на документацию API непосредственно в нашей вики проекта, но для вас может быть более приемлемо выводить документы как полностью функционирующий веб-сайт. Какой бы подход вы ни выбрали, вам придется вводить 

// https://webformyself.com/dokumentirovanie-proektov-javascript/