Javascript-форум (https://javascript.ru/forum/)
-   Общие вопросы Javascript (https://javascript.ru/forum/misc/)
-   -   javascript Docs (https://javascript.ru/forum/misc/44918-javascript-docs.html)

tsigel 06.02.2014 17:09

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} 
 */
}


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

Подскажите пожалуйста.

kobezzza 06.02.2014 18:07

https://developers.google.com/closur...compiler#types

danik.js 06.02.2014 18:41

А как писать jsdoc для defineProperty?
Object.defineProperty(ElementStack.prototype, 'length', {
	get: function() {
		return this.elements.length;
	}
});

Вобще, бесит что сеттеры/геттеры нужно создавать через вызов функции (хотя вот с литералом сделали гуд).

kostyanet 06.02.2014 19:04

С трудом представляю как func которая string может изобразить в типах метод, который function.


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