Javascript-форум (https://javascript.ru/forum/)
-   Оффтопик (https://javascript.ru/forum/offtopic/)
-   -   как лучше комментировать (https://javascript.ru/forum/offtopic/39299-kak-luchshe-kommentirovat.html)

neWjs 24.06.2013 18:14

как лучше комментировать
 
Как лучше написать комментарий для параметров передаваемых функции, к примеру , функции foo, передаеться объект со свойствами a,b.

// описать свойства которые могут быть установленны
function foo(params) {
 return params.a + params.b;
}

kobezzza 24.06.2013 19:05

Цитата:

Сообщение от neWjs (Сообщение 258219)
Как лучше написать комментарий для параметров передаваемых функции, к примеру , функции foo, передаеться объект со свойствами a,b.

// описать свойства которые могут быть установленны
function foo(params) {
 return params.a + params.b;
}

JSDoc
http://ru.wikipedia.org/wiki/JSDoc
https://developers.google.com/closur...s-for-compiler


/**
 * @param {!Object} params
 * @param {string} params.a - описание, параметр 1
 * @param {string} params.b - описание, параметр 2
 * @return {string}
 */
function foo(params) {
 return params.a + params.b;
}

melky 24.06.2013 19:06

описывать лучше в формате JSDOC
/**
 * Применит плюс к свойствам "a" и "b" переданного объекта
 * @param {{a: string, b: string}} params
 * @return {string}
 */ 
function foo(params) {
    return params.a + params.b;
}

neWjs 24.06.2013 19:18

melky,
kobezzza,
спасибо.


Часовой пояс GMT +3, время: 05:41.