注释规则

前端开发规范——注释规范，主要包括文件、HTML、CSS、JavaScript、属性、顶部文档、功能模块、函数的注释

注释规则

• 4、单行注释使用//。将单行注释放在需要注释的语句上方。注释之前一个空行隔开，除非是代码块的第一行 5、所有注释符和注释内容用一个空格隔开，易阅读
• 文件
  • 公共组件和各模块的维护者需要在文件头部加上注释说明
  • 无效代码直接删除
    • 无效代码直接删除
• HTML注释
  • 语义化
  • 无效代码直接删除
• css注释
  • 无效代码直接删除
    • 无效代码直接删除
• js注释
  • 注释单独占一行，不要在代码后的同一行内加注释
  • 使用多行注释/** ... */ ：包含描述、指定所有参数的返回值的类型和值
  • 单行注释使用//。将单行注释放在需要注释的语句上方。注释之前一个空行隔开，除非是代码块的第一行
  • 给注释增加FIXME或TODO的前缀，可帮助其他开发者快速了解这是一个需要复查的问题，或是给需要实现的功能提供一个解决方式。例如FIXME -- need to figure this out / TODO -- need to implement
  • //FIXME：标注问题；//TODO：标注问题的解决方式
  • 无效代码直接删除
• 属性注释
  • /* Header */、/* Nav */、/* Container */
• 顶部文档注释
  • /* 2 * @description: 中文说明 3 * @author： name 4 * @update： name（xxxx-xx-xx） 5 */
  • 无效代码直接删除
    • 无效代码直接删除
• 功能模块注释
  • /* module: module name1 by author1 */
    • 无效代码直接删除
  • 无效代码直接删除
• 函数注释
  • /** @param {String} tag * @return {Element} element */
  • 无效代码直接删除
  • 注释名 语法 含义 实例 @param @param 参数名 { 参数类型} 描述信息 参数信息 @param name {String } name @return @return {返回类型} 描述信息 返回信息 return {boolean}true:可执行；false：不可 @author @author 作者信息[附属：邮箱,日期] 函数作者 @author 张三 2015-06-23 @version @version xx.xx.xx 函数版本信息 @version 1.0.3 @example @example 示例 演示函数作用 @example setTitle（‘test’）