baskerville42
@baskerville42
Учусь работать (Junior)

Как правильно комментировать код JS?

Когда смотрю код каких-то библиотек, часто натыкаюсь на комментарии такого вида
/**
                 * Описание функции и тд
                 * @param name
                 * @param defaultValue
                 * @returns {*}
                 */


Вот интерестно есть ли best-practice как правильно комментировать и что это за "параметры" (@param, @returns, @value) и где достать список всех доступных?
  • Вопрос задан
  • 5058 просмотров
Решения вопроса 3
copal
@copal
𝄞 ...оооо baby
/**
 * [param description]
 * @type {[type]}
 */
var param = null;

/**
 * [method description]
 * @param  {[type]} a [description]
 * @param  {[type]} b [description]
 * @param  {[type]} c [description]
 * @return {[type]}   [description]
 */
function method(a, b, c){
	return a + b + c;
}
Ответ написан
evnuh
@evnuh
Поиск Гугл помог мне, впусти и ты его в свой дом
@param - для генерации документации, blog.fusioncharts.com/2013/12/jsdoc-vs-yuidoc-vs-d...
Как комментировать - как докогенератору угодно и как вам самим угодно
Ответ написан
k12th
@k12th
console.log(`You're pulling my leg, right?`);
WebStorm хорошо понимает JsDoc.

P.S. Хорошо понимает — значит, строит интеллисенс согласно типам, указанным в JsDoc и помогает написать его правильно.
Ответ написан
Пригласить эксперта
Ответы на вопрос 1
trevoga_su
@trevoga_su
я пишу в стиле php-doc.
стандартизировано и приятно читать
Ответ написан
Комментировать
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы