Тема: javascript Docs
Показать сообщение отдельно
  #1 (permalink)  
Старый 06.02.2014, 17:09
Профессор
Отправить личное сообщение для tsigel Посмотреть профиль Найти все сообщения от tsigel
 
Регистрация: 12.12.2012
Сообщений: 1,398

javascript Docs
Здравствуйте!

Привык писать код с доками, но никогда не писал доки на Callback.
Стал искать и что-то не понял как их писать правильно чтобы ide не ругалась.

Разрабатываю в idea 13 или phpstorm 7.1.

Вот простой пример функции с callback, подскажите как правильно написать доки:

var SomeObj = {

           /**
             * Перебор объекта
             * @method itarObj
             * @param {Object} obj
             * @param {SomeObj~requestCallback} func
             */
            itarObj: function (obj, func) {
                for (var key in obj)
                    if (obj.hasOwnProperty(key))
                        func(obj[key], key);
            }
/**
 * @callback SomeObj~requestCallback func
 * @param {*} 
 * @param {string} 
 */
}


Образец взял тут.

Подскажите пожалуйста.
Ответить с цитированием