命令名描述@param @argument 指定参数名和说明来描述一个函数参数@returns 描述函数的返回值@author 指示代码的作者@deprecated 指示一个函数已经废弃,而且在将来的 ...
什么是 JSDoc JSDoc 是一个根据 JavaScript 文件中注释信息,生成 JavaScript 应用程序或模块的API文档的工具。你可以使用 JSDoc 标记如:命名空间,类,方法,方法参数等。从而使开发者能够轻易地阅读代码,掌握代码定义的类和其属性和方法,从而降低维护成本,和提高开发效率。 JSDoc 注释规则 JSDoc注释一般应该放置在方法或函数声明之前,它必须以 开始,以便 ...
2020-12-31 16:18 0 349 推荐指数:
命令名描述@param @argument 指定参数名和说明来描述一个函数参数@returns 描述函数的返回值@author 指示代码的作者@deprecated 指示一个函数已经废弃,而且在将来的 ...
什么是 JSDoc JSDoc 是一个根据 JavaScript 文件中注释信息,生成 JavaScript 应用程序或模块的API文档的工具。你可以使用 JSDoc 标记如:命名空间,类,方法,方法参数等。从而使开发者能够轻易地阅读代码,掌握代码定义的类和其属性和方法,从而降低维护成本,和提高 ...
命令名描述 @param @argument 指定参数名和说明来描述一个函数参数@returns 描述函数的返回值@author 指示代码的作者@deprecated 指示一个函数已经废弃,而 ...
js注释规范基于jsdoc,写出的代码注释能够成功生成注释文档。 参数和返回值类型Type:string、boolean、number、object、array、function 文件注释 在文件头部增加文件注释 变量注释 将关键的变量进行特殊注释,生成到文档中 ...
官方文档 http://usejsdoc.org/ - sublime插件 https://github.com/spadgos/sublime-jsdocs - 生成文档 生成html: (1)安装:npm install jsdoc -g (2)执行:jsdoc test.js ...
@import url(http://www.cnblogs.com/Load.ashx?type=style&file=SyntaxHighlighter.css); @import url(/css/cuteeditor.css); 1. 注释宏或者常量 ...
1 规范目的 一个软件的生命周期中,80%的花费在于维护; 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护; 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码。为了执行规范,每个软件开发人员必须一致遵守编码规范; 使用统一编码规范 ...