文件注释
文件注释位于文件的最前面，应包括文件的以下信息: 概要说明及版本(必须)项目地址(开源组件必须)版权声明(必须)开源协议 (开源组件必须) 版本号(必须) 修改时间(必须)，以ISO格式表示(可使用Sublime Text的insertDate插件插入)文件注释必须全部以英文字符表示，并存在于文件的开发版本与生产版本中。例如:
/*! * jRaiser 2 Javascript Library * waterfall - v1.0.0 (2013-03-15T14:55:51+0800) * http://jraiser.org/ | Released under MIT license */
/*! * kan.56.com - v1.1 (2013-03-08T15:30:32+0800) * Copyright 2005-2013 56.com */
如果文件内包含了一些开源组件，则必须在文件注释中进行说明。例如：
/*! * jRaiser 2 Javascript Library * sizzle - v1.9.1 (2013-03-15T10:07:24+0800) * http://jraiser.org/ | Released under MIT license * * Include sizzle (http://sizzlejs.com/) */
模块注释
/** * 模块说明 * @module 模块名 */
例如：
/** * 模块说明 * @module 模块名 */
类注释
/** * 类说明 * @class 类名 * @constructor */
@class必须搭配@constructor或@static使用，分别标记非静态类Q与静态类
/** * 节点集合类 * @class NodeList * @constructor * @param {ArrayLike<Element>} nodes 初始化节点 */
函数注释
/** * 方法说明 * @function 方法名 * @for 所属类名 * @param {参数类型} 参数名 参数说明 * @return {返回值类型} 返回值说明 */
没有指定@for时，表示此函数为全局或模块顶层函数。当函数为静态函数只 时，必须添加@static;当函数有参数时，必须使用@param; 当函数有返回值时，必须使用@return
/** * 返回当前集合中指定位置的元素 * @method * @for NodeList * @param {Number} [i=0] 位置下标。如果为负数，则从集合的最后一个元素开始倒数 * @return {Element} 指定元素 */
![[JS]同事：这次就算了，下班回去赶紧补补内置函数，再犯肯定被主管骂](https://ucc.alicdn.com/3mfxe2r26qbaq/developer-article1635463/20241109/c55917b4a28342b78633c9da58d86e30.png?x-oss-process=image/resize,h_160,m_lfit)