Question

我想知道如何使用jsdoc记录此类课程：

var MyObject = (function(){

  var that = {};

  function privateFunction(){};

  that.publicFunction = function(){};

  that.publicField = "foo";

  return that;

})();

Answer 1

有许多名为JSDoc的东西，但使用closure compiler注释与jsdoc toolkit一起使用，您可以使用@constructor将MyClass标记为构造函数。

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

然后，您可以明确指出that属于名义类型MyClass，但很明显名义类型不适用于instanceof。

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

第一个@type建立声明的类型，第二个是值的类型断言/强制转换。

使用这些方法，您可以使用@this注释。

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

如何使用jsdoc记录这个？

1 个答案: