前端代码注释规范

HTML注释

<!--
    @name: Drop Down Menu
    @description: Style of top bar drop down menu.
    @author: zhangsan
-->

<!-- ***模块 -->
<div class="article-list">
...
</div>

js注释

• 文件说明

/**
 * @description: 说明文字
 * @author: 张三
 */

/**
 * @description: 说明文字
 * @author: 张三
 * @update: 更新内容 by 李四 2013-04-13 18:32
 */

• 方法说明

/**
* My method description.  Like other pieces of your comment blocks, 
* this can span multiple lines.
*
* @method methodName
* @param {String} foo Argument 1
* @param {Object} config A config object
* @param {String} config.name The name on the config object
* @param {Function} config.callback A callback function on the config object
* @param {Boolean} [extra=false] Do extra, optional work
* @return {Boolean} Returns true on success
*/

样式

/* header */
...
/* footer */
...
/* banner */
...