js文件头部注释（vscode使用koroFileHeader）

内容介绍：

• 使用/…/作为js文件注释，包含概要介绍、版本信息、版权声明、开源协议、修改时间等说明内容
• 使用/**…*/作为API文档注释，包含描述和制定所有参数和返回值的类型等
• 如vscode使用koroFileHeader插件在新建文件时自动生成文件头部注释，可在setting.json中进行配置(头部注释：ctrl+alt+i 函数注释：ctrl+alt+t)

常用注释关键字：

注释名	语法	含义	示例
@function	@function 简要描述	用于定义当前对象是一个函数，后面可跟描述	@function 处理表格的行
@description	@description 描述信息	用于描述	@description 合并Grid的行
@param	@param 参数名 {参数类型} 描述信息	描述参数的信息	@param name {String} 传入名称
@return	@return {返回类型} 描述信息	描述返回值的信息	@return {Boolean} true:可执行;false:不可执行
@author	@author 作者信息 [附属信息：如邮箱、日期]	描述此函数作者的信息	@author 张三 2015/07/21
@version	@version XX.XX.XX	描述此函数的版本号	@version 1.0.3
@example	@example 示例代码	演示函数的使用	@example setTitle(‘测试’)

---

标签：javascript，注释，参数，vscode

---

更多演示案例，查看 案例演示

---

欢迎留言讨论!