2

私は、jsdoc3をクロージャー辞書で使用して、jsdocするための最良の方法を見つけようとしています。以下のコードは、私が望むほとんどのものを文書化していますが、@classタグは文書に新しいキーワードを追加し、実際にはクラスではないため、クラス定義を使用することにも不安があります。

/**
 * myObject constructor. <strong> Do not use with new.</strong>
 * @class myObject
 * @param {string} someText The text to store
 */
function myObject (someText) {  
  var instance = Object.create(myObject.prototype);  
  instance.someText = someText;

  return instance;
}

/**
 * Outputs to the console
 */
myObject.prototype.doSomething = function () {
  console.log(this.someText);
};

var test = myObject('foobar');
test.doSomething();

@namespace@param元々はより良​​い選択のように見えましたが、疑似コンストラクターでの文書化などは許可されていません。どんな助けでも大歓迎です。

4

2 に答える 2