Warning: file_get_contents(/data/phpspider/zhask/data//catemap/9/javascript/449.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Javascript 如何使用jsdoc来记录这一点?_Javascript_Documentation_Jsdoc - Fatal编程技术网

Javascript 如何使用jsdoc来记录这一点?

Javascript 如何使用jsdoc来记录这一点?,javascript,documentation,jsdoc,Javascript,Documentation,Jsdoc,我想知道如何使用jsdoc记录这种类型的类: var MyObject = (function(){ var that = {}; function privateFunction(){}; that.publicFunction = function(){}; that.publicField = "foo"; return that; })(); 有许多名为JSDoc的东西,但是使用与一起工作的注释,您可以使用@constructor将MyClass标记为构

我想知道如何使用
jsdoc
记录这种类型的类:

var MyObject = (function(){

  var that = {};

  function privateFunction(){};

  that.publicFunction = function(){};

  that.publicField = "foo";

  return that;

})();

有许多名为JSDoc的东西,但是使用与一起工作的注释,您可以使用
@constructor
MyClass
标记为构造函数

/** @constructor */
var MyClass = ...;
然后您可以明确指出,
属于标称类型
MyClass
,尽管该标称类型显然不适用于的实例

/** @type MyClass */
var that = /** @type {MyClass} */ {};
第一个
@type
建立声明的类型,第二个是值的类型断言/转换

通过这些方法,您可以使用此注释

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

什么是
that.publicFunction(){}?也许在括号前需要一个
=函数
。为什么一个带有
publicFunction
属性和
publicField
属性的对象被视为类?也许结尾不应该有一个
{}
?@Mike感谢您注意到
public函数
stuff@Mike实际上,MyClass
MyClass
更像是一个单例对象。不打算将其与'new'关键字一起用于创建实例+1这很有用。我用了非常糟糕的术语
MyClass
不会成为类(不会与
new
关键字一起使用),我已将其更改为
MyObject
是否有方法将构造函数置于命名空间下?我尝试过使用memberof,但似乎没有任何改变。@porlune,
my.namespace.MyClass=function…