我有一些返回promise对象的代码，例如使用QNodeJS库。varQ=require('q');/***@returns???*/functiontask(err){returnerr?Q.reject(newError('Someerror')):Q.resolve('Someresult');}如何使用JSDoc记录这样的返回值？ 最佳答案 即使它们在Javascript中不存在，我发现JSdoc理解“泛型类型”。因此您可以定义您的自定义类型，然后使用/*@returnPromise*/.下面的结果是一个不错的TokenCo
我有一些返回promise对象的代码，例如使用QNodeJS库。varQ=require('q');/***@returns???*/functiontask(err){returnerr?Q.reject(newError('Someerror')):Q.resolve('Someresult');}如何使用JSDoc记录这样的返回值？ 最佳答案 即使它们在Javascript中不存在，我发现JSdoc理解“泛型类型”。因此您可以定义您的自定义类型，然后使用/*@returnPromise*/.下面的结果是一个不错的TokenCo
如果这是一个愚蠢的问题，请原谅我，但我对如何在Windows上使用JSDoc感到非常困惑。我知道JSDoc-Toolkit，但它有点过时了，谷歌代码库建议改用JSDoc3。我已经从Github下载了JSDoc，并将jsdoc-master文件夹解压缩到我的本地磁盘上，但找不到任何关于如何使用它来解析我的文件的可靠信息。 最佳答案 您可以downloaditasannpmpackage对于Node.jsJavaScriptruntimeenvironment.安装Node.js附带npm打开命令行输入以下命令安装JsDocnpmins
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion或者他们只是不在源代码中？我真的很想得到一些东西来阻止js-doc-toolkit每次解析jQuery时都崩溃。这也意味着我无法正确记录任何使用jQuery作为依赖项的代码，除非至少放置一些样板js-docblock，这些block无法正确记录jQuery的结构。有没有我不知道的通用解决方案？顺便说一句，我试过谷歌搜索。
我正在尝试使用JSDoc-toolkit记录我的代码。我的代码首先被包裹在一个自执行的匿名函数中。我到底如何记录这个？我几乎一整天都在这上面度过。JSDocs不会识别匿名函数闭包内部的任何内容，因为它不知道如何处理它。它坏了，我的评论都没有通过。我的代码看起来像这样。/***@fileoverviewBLABLABLA*//***ThisiswhereIdon'tknowwhattoput.*/(function(){"usestrict";/**orhere*/varstlib=function(param,param,param){/**orhere*/varshare={/**o
我想指出一个参数应该是一个DOM节点，但我似乎无法找到任何关于如何使用JSDoc来表明这一点的信息。我可以只使用{Object}，但这相当丑陋。我更愿意使用{Node}或{DOMNode}之类的东西，但我找不到任何示例来指向那个方向。那么，如何将参数标记为需要DOM节点？ 最佳答案 来自jsdoc.app对于@type注释:AtypeexpressioncanincludetheJSDocnamepathtoasymbol(forexample,myNamespace.MyClass);abuilt-inJavaScripttype
这个问题在这里已经有了答案:Howtodescribe"object"argumentsinjsdoc?(6个答案)关闭6年前。我正在使用jQuery的$.widget()基“类”，它提供了一个option()方法。由于该方法不在我的代码中，因此我没有地方记录该参数。我试图将jsDoc放在默认选项文字的字段上，但它们根本没有被拾取。然后我尝试在同一个对象字面量上使用@class和@lends标签，但这可能会让人很困惑，因为对象字面量并不是真正的类。我尝试过的另一种选择是在构造函数的jsDoc中放置类似@paramoptions.fielddescription的内容。但是，这样做的缺点
我一直在尝试使用JSDoc3生成文件文档，但遇到了一些困难。该文件(这是一个Require.js模块)基本上如下所示:define([],function(){/**@exportsmystuff/foo*/varfoo={/***@member*/bar:{/***@method*/baz:function(){/*...*/}}};returnfoo;}问题是，我无法让baz出现在生成的文档中。相反，我只是得到一个foo/foo模块的文档文件，其中列出了一个bar成员，但是bar没有baz(只是指向foo源代码的链接)。我尝试将bar的指令更改为@property，并且尝试将baz
在某处是否有jsdoc参数标签的有效类型列表？例如，@param{type}myParamSomeparameterdescription我知道像number和String这样的东西是有效的，但是如果我想记录数字是一个整数怎么办。int是否有效？我用谷歌搜索了一下，但似乎找不到完整列表。 最佳答案 无论如何，我使用的JS文档工具只是将注释标记为字符串，这样就可以在{type}部分中放置任何你想要的东西。如果你想要{number}或{string}，或者如果你想指定你可以做{integer}，你可以坚持使用JavaScript类型..
我正在尝试记录一个Express中间件，但是WebStorm中的内置验证工具告诉我在以下JSDocblock中错误地分配了类型:/***Mymiddleware.**@param{Object}req*@param{Object}res*@param{Function}next*@return{Object}*/exports.show=function(req,res,next){...};在Express资源中，我没有找到任何@typedef来帮助我。另外，我想避免像@param{*}这样的事情。使用JSDoc记录Express中间件的正确方法是什么？感谢您的帮助。
