草庐IT

jsdoc-toolkit

全部标签

javascript - JsDoc、ES6 和@param {Constructor}

我正在尝试使用JsDoc来记录es6类。无法相信您不能将类作为参数传递(类类型,而不是实例类型)。我一直在尝试一些事情,但无法让这个简单的代码正常工作,因此JsDoc不会向我抛出一些警告。除非我为我的每个类创建一个@typedef,然后手动将所有自己的和继承的成员添加到它,否则我无法让它工作。甚至不能做mixin!有没有人成功传递构造函数/类参数?让JsDoc处于静态上下文中,而不是实例上下文中?/***@classA*/classA{/***@static*/statichelloFromClassA(){}}/***@classB*@extendsA*/classBextendsA

javascript - JSDoc 和 JavaScript 单例文档

我有一个JavaScript单例定义为:/***Adescriptionhere*@class*/com.mydomain.ClassName=(function(){/***@constructor*@lendscom.mydomain.ClassName*/varClassName=function(){};/***methoddescription*@public*@lendscom.mydomain.ClassName*/ClassName.prototype.method1=function(){};returnnewClassName();})();在详细模式(-v)下不打

javascript - 使用 jsdoc 创建自定义标签

我正在尝试在jsdoc3.4.2中创建自定义标签。config.json文件是{"tags":{"allowUnknownTags":true,"dictionaries":["jsdoc","closure"]},"source":{"include":["app/"],"exclude":[],"includePattern":".+\\.js(doc|x)?$","excludePattern":"(^|\\/|\\\\)_"},"plugins":["plugins/custom-tags.js"],"templates":{"cleverLinks":false,"monos

javascript - 使用@method 或@property 的JSDoc 对象方法?

JSDoc3的documentation包括这个例子:/***ThecompleteTriforce,oroneormorecomponentsoftheTriforce.*@typedef{Object}WishGranter~Triforce*@property{boolean}hasCourage-IndicateswhethertheCouragecomponentispresent.*@property{boolean}hasPower-IndicateswhetherthePowercomponentispresent.*@property{boolean}hasWisdo

javascript - JSDoc:箭头函数参数

我正在尝试使用JSDoc(EcmaScript2015、WebStorm12Build144.3357.8)记录我的代码。我有一个箭头函数,我想记录它的参数。这两个示例有效(我得到自动完成):/**@param{Number}num1*/vara=num1=>num1*num1;//------------------------------/**@param{Number}num1*/vara=num1=>{returnnum1*num1;};但是当我想在forEach函数中记录箭头函数时,例如,自动完成功能不起作用(以下所有情况):/**@param{Number}num1*/[]

javascript - 在带有流类型注释的js上使用jsdoc

当尝试处理带有流类型注释的js源代码时,jsdoc解析器无法理解增强的语法!有没有一种方法可以在使用流类型注释增强的js源代码中使用jsdoc,或者从类型注释的js生成文档的推荐方法是什么? 最佳答案 刚开始使用documentation.js.开箱即用地支持JSdoc和流。 关于javascript-在带有流类型注释的js上使用jsdoc,我们在StackOverflow上找到一个类似的问题: https://stackoverflow.com/questi

javascript - 使用 JSDoc 记录成员函数

我有这样的东西:/**DieseKlasseblabla...@constructor**/my.namespace.ClassA=function(type){/**Thisfunctiondoessomething**/this.doSomething=function(param){}}该类将列在生成的文档中。该功能不会。有没有办法告诉JSDoc(3)这是ClassA类的成员函数? 最佳答案 试试这个!/***DieseKlasseblabla...*@constructor*/my.namespace.ClassA=func

javascript - 如何在 JSDoc 中记录事件处理程序?

假设我有这样一个类:functionmyClass(q){this.someFunction=function(e){console.log("Clickevent");};jQuery(q).click(this.someFunction);}有没有办法向JSDoc表明someFunction不仅仅是一个应该直接调用的函数,而是一个事件处理程序?我看到了@event标签,但如果我理解正确的话,这更多是为了记录我认为是事件的类中的函数(客户端代码也会注册,并且我的类会在需要时触发)而不是一个事件处理函数? 最佳答案 关键词是@lis

javascript - 如何使用 jsdoc 记录函数生成器?

我正在尝试记录一个函数生成器但没有成功,这是一个例子:functiongenericObjectGenerator(tagname){varspecificObject=function(){};specificObject.getClassName=function(){returntagname;}specificObject.prototype.sayHello=function(name){returntagname+"sayshelloto"+name;}returnspecificObject;}varMyObject=genericObjectGenerator("obj

javascript - 是否可以告诉 jsdoc 在与源代码分开的文件中查找该代码的文档?

我希望内联评论尽可能短,因为我的经验是超过3或4行的评论往往被掩盖,造成很多不必要的“阅读手册行”。遗留要求我遵守与jsdoc兼容的格式来记录代码。如果要正确记录很多不言而喻的事情,就需要明确声明。实际上每个标签都属于这一类。即使是那些没有的对于工作的开发人员来说通常也是无用的。我的愿景是在代码本身内有一个开发人员实际阅读的快速摘要,但引用一个单独的文件(或者甚至是同一文件中的评论转储,与开发人员工作的地方分开)以进行额外标记,像这样:/***Usedwhenmakinganexampleoftheargument.*@includesomeotherplace*/functionex