Javascript.RU

Создать новую тему Ответ
 
Опции темы Искать в теме
  #1 (permalink)  
Старый 18.07.2018, 18:52
Интересующийся
Отправить личное сообщение для NO_ONE Посмотреть профиль Найти все сообщения от NO_ONE
 
Регистрация: 01.03.2014
Сообщений: 19

Документирование анонимной функции (JSDoc)
Здравствуйте. Как правильно документировать анонимную функцию, которая сама вызывается? К сожалению, с JSDoc работаю впервые и знаю только азы.

Имеется небольшая библиотека со следующим паттерном:

!function (b, c, d, e) {

  // приватная функция
  var foo = function(a,b) {
  };

  // главный селектор, публичная функция: $(object)
  window.$ = function(a, b) {
    return new foo(a, b);
  };

  $[b] = foo[b] = $.fn = foo.fn = {

    // метод публичной функции: $(object).test(a,b)
    test: function (a, b) {}

  };


}(arg,arg,arg);



Вот что у меня получилось:

/**
* @name $
* @description ...
*/
!function (b, c, d, e) {

  /**
  * ...
  * @private
  */
  var foo = function(a,b) {
  };

  /**
   * @lends $
   * @global
   * @description ...
   * @param {object} a ...
   * @param {string} [context] ...
   * @returns {object} ...
   * @example ...
   */
  window.$ = function(a, b) {
    return new foo(a, b);
  };

  
  $[b] = foo[b] = $.fn = foo.fn = {

    /**
     * @method
     * @memberof $
     * @global
     * @arg {string} a ...
     * @arg {function} b ...
     * @returns {object} ...
     * @example ...
     */
    test: function (a, b) {}

  };


}(arg,arg,arg);


Но так JSDoc выводит только функцию "$".
Ответить с цитированием
Ответ



Опции темы Искать в теме
Искать в теме:

Расширенный поиск


Похожие темы
Тема Автор Раздел Ответов Последнее сообщение
Полифилл в анонимной функции NO_ONE Общие вопросы Javascript 1 14.07.2018 12:07
Вызов объекта из анонимной функции. Подскажите как работает код. mnzi Events/DOM/Window 9 16.02.2018 11:45
Документирование кода JSDoc mlounge Общие вопросы Javascript 0 27.09.2016 19:29
callback для анонимной функции gh321 jQuery 2 18.11.2013 13:20
jsdoc (документирование protected свойств) Tim Оффтопик 19 04.06.2012 00:20