javascript - jsdocを使用してこれを文書化する方法は？

Question

以下を使用してこのタイプのクラスを文書化する方法を知りたいのですがjsdoc。

var MyObject = (function(){

  var that = {};

  function privateFunction(){};

  that.publicFunction = function(){};

  that.publicField = "foo";

  return that;

})();

Answer 1

JSDocという名前のものはたくさんありますが、jsdocツールキットで機能するクロージャコンパイラアノテーションを使用すると、コンストラクタとしてマークするために使用できます。@constructorMyClass

/** @constructor */
var MyClass = ...;

that次に、それが記名型であることを明確にすることができますがMyClass、明らかにその記名型はで機能しませんinstanceof。

/** @type MyClass */
var that = /** @type {MyClass} */ {};

1@typeつ目は宣言のタイプを確立し、2つ目は値のタイプアサーション/キャストです。

メソッドを使用すると、@thisアノテーションを使用できます。

/** @this MyClass */
that.publicFunction = function () { ... };