Как правильно написать jsdoc (require.js + backbone)?

Здравствуйте.
Перейду сразу к вопросу, минуя воду.

Есть набор модулей/классов следующего вида:

Parent
define([
  "backbone", "lodash", "jquery"
], function (
  Backbone, _, $
){
  return Backbone.View.extend({...})
}


Child
define([
  "parentClass"
], function (
  parentClass
){
  return parentClass.extend({...})
}


Вопрос: как правильно написать jsDoc к таким конструкциям, чтобы учесть все зависимости?
(В идеале, сделать так, чтобы IDE (idea/phpStorm) стала понимать что используется свойство/метод родительского класса, а в мечтах - построить граф зависимостей, чтобы посмотреть - что зависит от отдельно взятого метода, но это будут уже другие вопросы).
P.S.: пробовал много решений, но ничего толкового не получилось, здесь их описывать не буду.
  • Вопрос задан
  • 3203 просмотра
Решения вопроса 1
VovanR
@VovanR
Фронт-энд Вэб-разработчик
Я бы так сделал:

Parent
define([
    'backbone',
    'lodash',
    'jquery',
], function (
    Backbone,
    _,
    $
) {

    /**
     * @classdesc Best Parent class ever
     * @class
     */
    var Parent = Backbone.View.extend({
        ...
    });

    return Parent;

});


Child
define([
    'Parent',
], function (
    Parent
) {

    /**
     * @classdesc Little children
     * @class
     * @augments Parent
     */
    var Child = Parent.extend({
        ...
    });

    return Child;

});


Но есть ощущение, что здесь лучше подойдут модули AMD Modules
Ответ написан
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы