我一直在尝试使用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中间件的正确方法是什么？感谢您的帮助。

我有一些用CoffeeScript编写的代码，我想用GoogleClosureCompiler优化生成的JavaScript，所以这些文件需要用JSDoc记录。我的问题是，我如何记录*.coffee文件以生成包含适用于闭包编译器的JSDoc的javascript？还有一个问题:有没有办法在*.coffee中保留单行注释？ 最佳答案 CoffeeScript输入:###definefunctionvariablebeforeblocktoavoidcodebeingappendedtoclosingpartofJSDoccomment

在JsDoc中有没有规定方法或函数声明返回void的方式？目前我认为void是默认的返回值，其他返回值必须具体提供:/***@return{Integer}Theidentifierfor...*/ 最佳答案 闭包编译器根据Google的ClosureCompiler文档，如果没有返回任何内容，则应省略@return注释。Ifthereisnoreturnvalue,donotusea@returntag.来源:https://developers.google.com/closure/compiler/docs/js-for-co

假设您有如下内容:varsomeFunc=function(){//dosomethingherewitharguments}您如何在JSDoc中正确记录此函数可以采用任意数量的参数？这是我最好的猜测，但我不确定它是否正确。/***@param{Mixed}[...]Unlimitedamountofoptionalparameters*/varsomeFunc=function(){//dosomethingherewitharguments}相关:php-Howtodocavariablenumberofparameters 最佳答案

根据@param的JSDocwiki您可以使用指示@param是可选的/**@param{String}[name]*/functiongetPerson(name){}你可以指定一个参数inline使用functiongetPerson(/**String*/name){}我可以像下面这样组合它们，效果很好。/**@param[name]*/functiongetPerson(/**String*/name){}但我想知道是否有办法在可能的情况下全部内联完成。 最佳答案 来自officialdocumentation:可选参数An

我如何告诉JSDoc关于返回对象的结构。我找到了@return{{field1:type,field2:type,...}}description语法并试了一下:/***Returnsacoordinatefromagivenmouseortouchevent*@param{TouchEvent|MouseEvent|jQuery.Event}e*AvalidmouseortoucheventorajQueryeventwrappingsuchan*event.*@param{string}[type="page"]*Astringrepresentingthetypeoflocati

我花了很长时间在互联网上寻找使用jsdoc正确记录回调的最佳方法，但不幸的是，我还没有找到一个很好的方法。这是我的问题:我正在为开发人员编写一个Node.js库。该库提供了开发人员将使用的多个类、函数和方法。为了使我的代码清晰易懂，以及(希望)将来自动生成一些API文档，我已经开始使用jsdoc在我的代码中self记录正在发生的事情。假设我定义了如下函数:functionaddStuff(x,y,callback){callback(x+y);});使用jsdoc，我目前正在记录这个函数如下:/***Addtwonumberstogether,thenpasstheresultstoa

//MyfunctiondoesXandY.//@params{object}parametersAnobjectcontainingtheparameters//@params{function}callbackThecallbackfunctionfunction(parameters,callback){}但是我该如何描述参数对象的结构呢？例如它应该是这样的:{setting1:123,//(required,integer)setting2:'asdf'//(optional,string)} 最佳答案 来自@paramwi