Javascript.RU

Создать новую тему Ответ
 
Опции темы Искать в теме
  #1 (permalink)  
Старый 24.06.2013, 18:14
Аспирант
Отправить личное сообщение для neWjs Посмотреть профиль Найти все сообщения от neWjs
 
Регистрация: 27.05.2012
Сообщений: 48

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

// описать свойства которые могут быть установленны
function foo(params) {
 return params.a + params.b;
}
Ответить с цитированием
  #2 (permalink)  
Старый 24.06.2013, 19:05
Аватар для kobezzza
Быдлокодер;)
Отправить личное сообщение для kobezzza Посмотреть профиль Найти все сообщения от kobezzza
 
Регистрация: 19.11.2010
Сообщений: 4,338

Сообщение от neWjs Посмотреть сообщение
Как лучше написать комментарий для параметров передаваемых функции, к примеру , функции 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;
}
__________________
kobezzza
code monkey

Последний раз редактировалось kobezzza, 24.06.2013 в 19:09.
Ответить с цитированием
  #3 (permalink)  
Старый 24.06.2013, 19:06
sinistral
Посмотреть профиль Найти все сообщения от melky
 
Регистрация: 28.03.2011
Сообщений: 5,418

описывать лучше в формате JSDOC
/**
 * Применит плюс к свойствам "a" и "b" переданного объекта
 * @param {{a: string, b: string}} params
 * @return {string}
 */ 
function foo(params) {
    return params.a + params.b;
}
Ответить с цитированием
  #4 (permalink)  
Старый 24.06.2013, 19:18
Аспирант
Отправить личное сообщение для neWjs Посмотреть профиль Найти все сообщения от neWjs
 
Регистрация: 27.05.2012
Сообщений: 48

melky,
kobezzza,
спасибо.
Ответить с цитированием
Ответ



Опции темы Искать в теме
Искать в теме:

Расширенный поиск


Похожие темы
Тема Автор Раздел Ответов Последнее сообщение
Решение проблемы кодировок для AJAX и PHP без iconv (cp1251 в AJAX) Serge Ageyev AJAX и COMET 10 24.04.2013 20:48
хотел как лучше, а получилось как всегда. Вопрос оптимизации 9xakep Общие вопросы Javascript 13 21.01.2013 17:27
как сделдать меню из двух калонок как в bestchange.ru Андрей Лебедев Элементы интерфейса 2 21.01.2013 10:32
Как лучше написать скрипт теста Dimaz jQuery 2 28.11.2012 16:08
Как лучше сделать глобальный массив skyfish AJAX и COMET 4 17.02.2009 18:05