УчитываяПравильный способ документирования класса в JSDoc
function Just (x) {
this.some = x;
this.other = 1;
}
что является наиболее рекомендуемым способом документировать этот класс в JSDoc? (Возьмите x
, чтобы быть string
).
УчитываяПравильный способ документирования класса в JSDoc
function Just (x) {
this.some = x;
this.other = 1;
}
что является наиболее рекомендуемым способом документировать этот класс в JSDoc? (Возьмите x
, чтобы быть string
).
/**
* Creates a new Just.
* @class
*/
Источник: http://usejsdoc.org/tags-class.html
Как насчет параметров? Как насчет членов? – zerkms
Да, как насчет 'x',' some' и 'value'? –
Это конструктор, а не класс. PS: http://usejsdoc.org/ PPS: покажите нам свою лучшую попытку и перейдем к [codereview.SE] (http://codereview.stackexchange.com/) – zerkms
@zerkms не являются двумя синонимами? – Todd
@Todd: с какой точки зрения? С точки зрения многих людей - да. Из стандарта [ECMAScript standard] (http://www.ecma-international.org/ecma-262/5.1/) - нет. – zerkms