1

次のJavaScriptがあります。

これは、オブジェクト リテラルに名前空間化された関数を持つ RequireJS モジュールです。私が言及したのは: How do I JSDoc A Nested Object's Methods? JSDoc 表記をマークアップする方法を見つけるには。

grunt タスクで JSDocs 3.3.0-beta3 を実行しprivate: trueましたが、モジュール ページには publich メソッドのプライベート メソッドまたは引数がありません。

/**
 * A module doing a lot of Foo.
 * @module Foo
 * @requires jquery
 * @author Markus Falk
 */
define(['jquery'], function($) {

  'use strict';

  /**
   * @property {Object} Container
   */
  var Foo = {
    /**
     * Caches all jQuery Objects for later use
     * @function
     * @private
     */
    _cacheElements: function() {
      this.$foo = $('.foo');
    },
    /**
     * inits the app and returns the Message Text
     * @function
     * @public
     * @param {Object} msg - The message.
     * @param {string} msg.text - The message's Text.
     * @param {string} msg.author - The message's author.
     * @returns {String} Sentence with given message.text
     */
    init: function(msg) {
      this._cacheElements();
      return "Say " + msg.text;
    }
  };

  return /** @alias module:Foo */ {
    /** init */
    init: Foo.init
  };
});

この JSDoc コードの出力は次のとおりです。

JSDocs

4

1 に答える 1