28

我有两种类型的模块：

Require.js 主文件：

    require.config({
      baseUrl: "/another/path",
      paths: {
        "some": "some/v1.0"
      },
      waitSeconds: 15,
      locale: "fr-fr"
    });


    require( ["some/module", "my/module", "a.js", "b.js"],
      function(someModule,    myModule) {
      }
    );

中介模式：

define([], function(Mediator){

var channels = {};
if (!Mediator) Mediator = {};  

Mediator.subscribe = function (channel, subscription) {   
  if (!channels[channel]) channels[channel] = [];
   channels[channel].push(subscription);
};

Mediator.publish = function (channel) {
  if (!channels[channel]) return;
  var args = [].slice.call(arguments, 1);
  for (var i = 0, l = channels[channel].length; i < l; i++) {
    channels[channel][i].apply(this, args);
  }
};

return Mediator;

});

如果可能的话，我如何用 jsdoc3 来记录这个？

4

5 回答 5

16

这是我对 SO 的第一个答案，请让我知道如何改进未来的答案。

你的具体例子

这两天我一直在寻找答案，似乎没有一种方法可以自动记录 RequireJS AMD 模块而没有一些冗余（如重复的函数名称）。Karthrik 的回答在生成文档方面做得很好，但是如果代码中的某些内容被重命名，文档仍然会从 jsDoc 标记中的内容生成。

我最终做的是以下内容，这是根据 Karthik 的示例进行调整的。注意第 1 行的标记，以及从 jsDoc 注释块@lends中删除的标记。@name

 define([], /** @lends Mediator */ function(Mediator){
    /** 
     * Mediator class
     * This is the interface class for user related modules
     * @class Mediator
     */

    var channels = {};
    if (!Mediator) Mediator = {};  

    /**
      * .... description goes here ...
      * @function 
      *
      * @param {Number} channel  ..... 
      * @param {String} subscription ..............
      * @example
      * add the sample code here if relevent.
      * 
      */        
    Mediator.subscribe = function (channel, subscription) {   
      if (!channels[channel]) channels[channel] = [];
       channels[channel].push(subscription);
    };

    Mediator.publish = function (channel) {
      if (!channels[channel]) return;
      var args = [].slice.call(arguments, 1);
      for (var i = 0, l = channels[channel].length; i < l; i++) {
        channels[channel][i].apply(this, args);
      }
    };

return Mediator;

});

据我了解，该@lends标记会将下一个对象文字中的所有 jsDoc 注释解释为该@lends标记引用的类的一部分。在这种情况下，下一个对象字面量是以 . 开头的字面量function(Mediator) {。该@name标记被删除，以便 jsDoc 在源代码中查找函数名称等。

注意：我在@exports放置标签的地方使用了@lends标签。虽然这可行，但它会在文档中创建一个模块……我只想为该类生成文档。这种方法对我有用！

一般 jsDoc 参考资料

于 2013-01-12T12:44:30.923 回答
9

jsDoc 似乎不喜欢“定义”和“要求”调用。

因此，我们最终使用多个标签来制作 jsDoc 工具来获取构造函数和其他特定的类方法。请看下面的例子：我刚刚从我的源代码中复制粘贴并用你的类名和方法名替换它。希望对你有效。

    define([], function(Mediator){
        /** 
         * Mediator class
         * This is the interface class for user related modules
         * @name Mediator
         * @class Mediator
         * @constructor
         * @return Session Object
         */

        var channels = {};
        if (!Mediator) Mediator = {};  

        /**
          * .... description goes here ...
          * @name Mediator#subscribe
          * @function 
          *
          * @param {Number} channel  ..... 
          * @param {String} subscription ..............
          * @example
          * add the sample code here if relevent.
          * 
          */        
        Mediator.subscribe = function (channel, subscription) {   
          if (!channels[channel]) channels[channel] = [];
           channels[channel].push(subscription);
        };

        Mediator.publish = function (channel) {
          if (!channels[channel]) return;
          var args = [].slice.call(arguments, 1);
          for (var i = 0, l = channels[channel].length; i < l; i++) {
            channels[channel][i].apply(this, args);
          }
        };

    return Mediator;

    });

注意：上述记录 JS 代码的方法在我们使用 jsDoc 时效果很好。还没有机会尝试 jsDoc3。

于 2012-04-27T06:22:28.180 回答
8

从 Muxa 的答案中获取链接，我们看到文档确实特别提到了 RequireJS：

RequireJS 库提供了一个定义方法，允许您编写一个函数来返回一个模块对象。使用 @exports 标记来记录对象文字的所有成员都应记录为模块的成员。

模块示例

define('my/shirt', function () {
   /** 
    * A module representing a shirt.
    * @exports my/shirt
    * @version 1.0
    */
    var shirt = {

        /** A property of the module. */
        color: "black",

        /** @constructor */
        Turtleneck: function(size) {
            /** A property of the class. */
            this.size = size;
        }
    };

    return shirt;
});

因此，在上面的示例中，我们看到 jsdoc 将解析一个my/shirt 模块并将其记录为具有两个成员：一个 propertycolor和一个 class Turtleneck。该类Turtleneck也将被记录为拥有它自己的属性size。

构造函数模块示例

使用 @alias 标记简化在 RequireJS 中记录构造函数模块。

/** 
 * A module representing a jacket.
 * @module jacket
 */
define('jacket', function () {
    /**
     * @constructor
     * @alias module:jacket
     */
    var exports = function() {
    }

    /** Open and close your Jacket. */
    exports.prototype.zip = function() {
    }

    return exports;
});

如果您将构造函数导出为模块，该模块将用作实例化对象的类，则上述内容是您想要使用的。总而言之，我不确定是否使用@lends已推荐的和其他标签/技术。相反，我会尝试坚持使用文档中引用 RequireJS@module的、@exports和@alias标签。

我不确定你应该如何记录你的 requirejs 'main' 文件。如果我理解正确，您实际上并没有在那里定义任何模块，而是执行依赖于多个模块的一次性功能。

于 2013-07-18T00:52:44.417 回答
2

My AMD classes use a slightly different form, but JSDoc wasn't documenting them either so I thought I'd share what worked for me.

Constructors in the global namespace are automatically added:

/**
* @classdesc This class will be documented automatically because it is not in
* another function.
* @constructor
*/
function TestClassGlobal() {
/**
* This is a public method and will be documented automatically.
*/
this.publicMethod = function() {
};
}

If you want this behavior on a constructor inside an AMD module, declare it either as global or a member of a namespace:

define([], function() {
/**
* @classdesc This won't be automatically documented unless you add memberof,
* because it's inside another function.
* @constructor
* @memberof Namespace
*/
function TestClassNamespace() {
}

/**
* @classdesc This won't be automatically documented unless you add global,
* because it's inside another function.
* @constructor
* @global
*/
function TestClassForcedGlobal() {
}
});
于 2014-02-25T19:43:08.313 回答
0

看起来事情在 JSDoc3 中变得简单多了。以下对我有用：

中介者作为一个模块

/**
 * Mediator Module
 * @module Package/Mediator
 */
define([], function(Mediator){

  var channels = {};
  if (!Mediator) Mediator = {};  

  /**
   * Subscribe
   * @param  {String} channel Channel to listen to
   * @param  {Function} subscription Callback when channel updates
   * @memberOf module:Package/Mediator
   */
  Mediator.subscribe = function (channel, subscription) {   
    if (!channels[channel]) channels[channel] = [];
     channels[channel].push(subscription);
  };

  /**
   * Publish
   * @param  {String} channel  Channel that has new content
   * @memberOf module:Package/Mediator
   */
  Mediator.publish = function (channel) {
    if (!channels[channel]) return;
    var args = [].slice.call(arguments, 1);
    for (var i = 0, l = channels[channel].length; i < l; i++) {
      channels[channel][i].apply(this, args);
    }
  };

  return Mediator;

});

但是，我可能会对代码进行以下更改：

/**
 * Mediator Module
 * @module Package/Mediator
 */
define([], function(){

  var channels = {};
  var Mediator = {}

  ...

原因是，模块说它定义了Mediator，但似乎是从Mediator. 我不确定我是否理解。在这个版本中，很明显Mediator是由这个文件定义并导出的。

于 2015-12-04T03:53:22.593 回答