什么是 JSDoc JSDoc 是一个根据 JavaScript 文件中注释信息,生成 JavaScript 应用程序或模块的API文档的工具。你可以使用 JSDoc 标记如:命名空间,类,方法,方法参数等。从而使开发者能够轻易地阅读代码,掌握代码定义的类和其属性和方法,从而降低维护 ...
js注释规范基于jsdoc,写出的代码注释能够成功生成注释文档。 参数和返回值类型Type:string boolean number object array function 文件注释 在文件头部增加文件注释 变量注释 将关键的变量进行特殊注释,生成到文档中 常量注释 将关键常量进行特殊注释,生成到文档中,如果有默认值增加 default属性 方法注释 基本方法块注释 如果描述不能描述清楚,添 ...
2019-01-02 11:20 1 1440 推荐指数:
什么是 JSDoc JSDoc 是一个根据 JavaScript 文件中注释信息,生成 JavaScript 应用程序或模块的API文档的工具。你可以使用 JSDoc 标记如:命名空间,类,方法,方法参数等。从而使开发者能够轻易地阅读代码,掌握代码定义的类和其属性和方法,从而降低维护 ...
命令名描述@param @argument 指定参数名和说明来描述一个函数参数@returns 描述函数的返回值@author 指示代码的作者@deprecated 指示一个函数已经废弃,而且在将来的 ...
什么是 JSDoc JSDoc 是一个根据 JavaScript 文件中注释信息,生成 JavaScript 应用程序或模块的API文档的工具。你可以使用 JSDoc 标记如:命名空间,类,方法,方法参数等。从而使开发者能够轻易地阅读代码,掌握代码定义的类和其属性和方法,从而降低维护成本,和提高 ...
命令名描述 @param @argument 指定参数名和说明来描述一个函数参数@returns 描述函数的返回值@author 指示代码的作者@deprecated 指示一个函数已经废弃,而 ...
官方文档 http://usejsdoc.org/ - sublime插件 https://github.com/spadgos/sublime-jsdocs - 生成文档 生成html: (1)安装:npm install jsdoc -g (2)执行:jsdoc test.js ...
使用JSDoc /**基础类型*/ /** @type {string} */ /**联合类型 */ /** @type {string | number ...
1.JSDoc安装和配置: JSDoc安装:使用npm安装npm install jsdoc –g JSDoc配置:进入JSDoc的安装目录找到并修改 conf.json.EXAMPLE进行自定义配置,也可以不做修改使用默认配置 2.JSDoc注释文档编辑: 格式 ...
jsDoc 说白了就是帮助你生成JS的文档,但有个前提,就是你编写的JS代码中,需要按一定的格式写注释后,这个工具软件才能帮你正确的生成文档! 一、配置使用环境。此软件是 JAVA写的,所以我们要在windows 系统中配置java的环境变量 1、下载jdk(http ...