前端小芬芬
前端小芬芬

前端代码规范

一、统一要求

1.1.基本规范

  1. 所有类名、id名、方法名等涉及到名称的，统一使用驼峰命名，命名要具有业务意义，语义化，简洁明了
  2. 代码中不得出现警告
  3. 代码中不得出现数字（插件除外）
  4. 结构（html），表现(css)，行为(js)代码需分离

1.2.基本原则

  1. 代码力求简洁，不要写大量重复的逻辑代码（公共方法需封装，公共样式提取到公共样式中）
  2. 代码要有可读性，函数和元素命名要具有业务意义，关键业务要有详细的注释
  3. 代码要有扩展性，要尽可能适应未来的业务变化，不得生搬硬套现有业务逻辑
  4. 代码要有通用性，一个方法只专注于该方法需要做的事情（对外暴露相应的参数），一个模块只专注于该模块范围内的事情（对外暴露相应的接口）

二、html规范

2.1.Charst字符集合

  1. 一般情况下统一使用UTF-8。尽量统一写成标准的 “UTF-8”，不要写成 “utf-8” 或 “utf8” 或 “UTF8”。根据 IETF对UTF-8的定义，其编码标准的写法是 “UTF-8”；

2.2.书写风格

  1. Html代码大小写
  • HTML标签名、类名、标签属性和大部分属性值统一用小写

  推荐：

2.元素属性

  • 属性值使用双引号语法

  例： 

3.特殊字符引用

  • 不得使用‘>’和‘<’特殊字符，浏览器会将它们作为标签解析，若要正确显示，在 HTML 源代码中使用字符实体

推荐：more>>

4.代码嵌套