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} */ {};

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

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

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