javascript注释规范

前言：

---

开发这么久，一直想着养成一个好的注释习惯，但一直没有一个好的，优秀的标准来要求自己，所以写出来的代码总感觉有点low。过多的JavaScript注释会降低JavaScript的执行速度与加载速度，因此应在发布网站时，去掉JavaScript注释。注释块（/* ... */）中不能有(/*或*/，JavaScript正则表达式中可能产生这种代码)，这样会产生语法错误。

好的注释

• //双斜杠 （单行注释）
• /*...*/斜杠星号 ，一般快捷键是/** Tab(回车) （多行注释）
• 注释标签的使用

标签	描述	实例
@module	标明当前的文件模块	/**@module Uploadfile */=>Upload模块
@submodule	子组建	/**@submodule Uploadfilesub */=>Upload子模块
@class	标示一个类	/**@class Upload */=>Upload类
@callback	表明这个方法是个回调	/**@callback Upload */=>Upload回调函数
@method	标记一个方法或函数	这个一般不用
@param	标记方法参数及参数类型
@todo	表明自己未完成的任务	/*** @param {string} 参数名*/