草庐IT

javascript - 如何在 jsdoc 中描述 "object"参数?

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

前端使用 js doc 生成接口文档

前言项目中使用到需要把js方法生成接口文档,使用到了JSdoc这个工具,使用该工具生成文档,需要在方法里加入注释,根据注释说明生成文档,这里顺便记录一下使用过程,模拟了一些js,演示一些使用到的注释信息,更多注释信息说明具体可以查看官方文档。JSdoc文档官方:https://jsdoc.app/中文文档:https://jsdoc.zcopy.site/源码地址:https://gitee.com/mirrors/JsDoc3入门创建一个名为:jsdoc-test-demo空文件夹,在文件夹下执行以下命令,进行安装#全局安装npminstall-gjsdoc#本地安装npminstall--

前端使用 js doc 生成接口文档

前言项目中使用到需要把js方法生成接口文档,使用到了JSdoc这个工具,使用该工具生成文档,需要在方法里加入注释,根据注释说明生成文档,这里顺便记录一下使用过程,模拟了一些js,演示一些使用到的注释信息,更多注释信息说明具体可以查看官方文档。JSdoc文档官方:https://jsdoc.app/中文文档:https://jsdoc.zcopy.site/源码地址:https://gitee.com/mirrors/JsDoc3入门创建一个名为:jsdoc-test-demo空文件夹,在文件夹下执行以下命令,进行安装#全局安装npminstall-gjsdoc#本地安装npminstall--

Jsdoc的高级用法:根据函数第一个参数,来确定剩余参数怎么传

jsdoc也叫文档注释,是JS开发中的一把利器,主要用于为JS添加类型声明,这样我们就可以像写TS一样写JS了。我之前写过一篇文章,讲述了jsdoc的基础用法。本篇文章,我们来看一个高级点的用法。我们来实现一个功能:根据函数的第一个参数,来确定剩余参数怎么传。我想实现如下函数,该函数用于向父窗口发送消息。它可以接收不确定个数的参数,其中第一个参数是eventType,该参数有固定的几个可选值,剩余参数根据eventType的值来确定。constsendEventToParentWindow=(eventType,...args)=>{window.postMessage(JSON.string

Jsdoc的高级用法:根据函数第一个参数,来确定剩余参数怎么传

jsdoc也叫文档注释,是JS开发中的一把利器,主要用于为JS添加类型声明,这样我们就可以像写TS一样写JS了。我之前写过一篇文章,讲述了jsdoc的基础用法。本篇文章,我们来看一个高级点的用法。我们来实现一个功能:根据函数的第一个参数,来确定剩余参数怎么传。我想实现如下函数,该函数用于向父窗口发送消息。它可以接收不确定个数的参数,其中第一个参数是eventType,该参数有固定的几个可选值,剩余参数根据eventType的值来确定。constsendEventToParentWindow=(eventType,...args)=>{window.postMessage(JSON.string

关于 javascript:如何 jsdoc 注释 BackboneJS 代码?

HowtojsdocannotateBackboneJScode?有没有人用JSDoc记录过BackboneJS代码?我在注释Backbone结构时遇到问题,例如:123456789101112User=Backbone.Model.extend({  defaults:{a:1},  initialize:function(){    //...  },  doSomething:function(p){    //...  }});任何建议表示赞赏。谢谢。因为JSDoc是JavaDoc的一个端口。所以它不是为JavaScript设计的。使用docco@Raynos一般来说你是对的,但是JS

关于 javascript:如何 jsdoc 注释 BackboneJS 代码?

HowtojsdocannotateBackboneJScode?有没有人用JSDoc记录过BackboneJS代码?我在注释Backbone结构时遇到问题,例如:123456789101112User=Backbone.Model.extend({  defaults:{a:1},  initialize:function(){    //...  },  doSomething:function(p){    //...  }});任何建议表示赞赏。谢谢。因为JSDoc是JavaDoc的一个端口。所以它不是为JavaScript设计的。使用docco@Raynos一般来说你是对的,但是JS