我有一些用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
我正在努力使用JSDocs记录router.get调用。如果我尝试将文档附加到我的路由器调用本身，我无法让文档在页面上正确显示。/***Healthcheck*@memberofhealth*/router.get('/happy',function(req,res){res.json({"status":"OK"});});为了解决这个问题，我为函数命名。router.get('/happy',happy);/***Healthcheck*@memberofhealth*/functionhappy(req,res){res.json({"status":"OK"});}这行得通，但
我花了很长时间在互联网上寻找使用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
//MyfunctiondoesXandY.//@params{object}parametersAnobjectcontainingtheparameters//@params{function}callbackThecallbackfunctionfunction(parameters,callback){}但是我该如何描述参数对象的结构呢？例如它应该是这样的:{setting1:123,//(required,integer)setting2:'asdf'//(optional,string)} 最佳答案 来自@paramwi
jsdoc也叫文档注释，是JS开发中的一把利器，主要用于为JS添加类型声明，这样我们就可以像写TS一样写JS了。我之前写过一篇文章，讲述了jsdoc的基础用法。本篇文章，我们来看一个高级点的用法。我们来实现一个功能：根据函数的第一个参数，来确定剩余参数怎么传。我想实现如下函数，该函数用于向父窗口发送消息。它可以接收不确定个数的参数，其中第一个参数是eventType，该参数有固定的几个可选值，剩余参数根据eventType的值来确定。constsendEventToParentWindow=(eventType,...args)=>{window.postMessage(JSON.string
