Какой можно написать JSDoc для генератора функций в Javascript?

Question

[Sa1en]

Привет!

Припустим у нас есть:

var root = {};

Так же, есть функция, которая создает геттер для key который будет возвращать value:

var define = function(key, value) {
root.__defineGetter__(key, function(){ return value });
};

define('test', 1);

В каком то другом файле я пытаюсь вызвать root.test - код, естественно, работает, но вот подсказки в IDE нету, и она (IDE) считает этот вызов ошибкой.

Как правильно задескрайбить функцию define с помощью JSDoc?
Ничего в голову не приходит.

Answer 1

[Eugene Obrezkov]

И правильно делает, что считает этот вызов ошибкой. Зачем же объявлять геттеры через __defineGetter__, когда можно через Object.create и Object.defineProperties() это сделать.

Comments

[Sa1en]

Но это не помогает решению вопроса. Даже если через defineProperty - какой JSDoc нужен?

[Eugene Obrezkov]

@Sa1en просто добавьте мета-теги к вашему геттеру. Подробнее здесь - usejsdoc.org

[Sa1en]

@ghaiklor да ладно! ;) какие именно?! В этом и вопрос. Не могу сообразить :(

[Eugene Obrezkov]

@Sa1en я конечно не сталкивался с таким извращением :) Попробуйте @method, @param, @returns, @type, @variable. Но терзают меня смутные сомнения что это не поможет. Это просто функция, данные-то уже динамически добавляете.

Answer 2

[ErBlack]

Лучше действительно пользовать Object.defineProperty().