如何使用jsdoc在类中共享方法文档?

时间:2016-10-26 21:26:41

标签: javascript jsdoc jsdoc3

我的类具有相同参数描述的方法。

/**
 * @constructor
 */
var Person = function (){};

Person.prototype = {

  /**
   * @param {!string} [arg] - words
   */
  whisper: function(arg){
      console.log(arg.toLowerCase());
  },

  /**
   * @param {!string} [arg] - words
   */
  shout: function(arg){
      console.log(arg.toUpperCase());
  },
};

如何在课堂上分享方法文档?

是否可以不仅共享方法文档,还可以将其与内联方法描述混合使用?示例:每个方法都有不同的@return类型。

0 个答案:

没有答案