前端编码规范
前端代码规范是一组约定和准则,旨在规范前端开发人员编写代码的风格、结构和组织方式,以提高代码的可读性、可维护性和可扩展性。这些规范通常涵盖 HTML、CSS 和 JavaScript 等前端技术的使用。
前端代码规范。持续补充...
关键词解释
本文档中的关键字“必须”、“不得”、“必需”、“应”、“不应”、“应该”、“不应”、“推荐”、“可以”和“可选”应按照 RFC 2119 中的描述进行解释。
必须 该词或术语“必需”或“SHALL”表示该定义是规范的绝对要求。
不得 这句话,或短语“不得”,意味着该定义是绝对禁止规范的。
应该 这个词,或形容词“推荐”,意味着在特定情况下可能存在忽略特定项目的正当理由,但在选择不同的课程之前,必须理解并仔细权衡全部含义。
不应 这句话或短语“不推荐”的意思是在特定情况下,当特定行为是可以接受的甚至有用的时,可能存在正当理由,但在实施与此标签描述的任何行为之前,应理解全部含义并仔细权衡情况。
可选 意味着一个项目是真正可选的。一个供应商可能会选择包含该项目,因为特定市场需要它,或者因为供应商认为它增强了产品,而另一个供应商可能会省略相同的项目。不包含特定选项的实现必须准备好与包含该选项的另一个实现进行互操作,尽管功能可能会减少。同样,包含特定选项的实现必须准备好与不包含该选项的另一个实现进行互操作(当然,该选项提供的功能除外)。
细则
必须
项目
必须使用公司内部组件库,可基于基础组件进行扩展。项目
小程序授权不得多次授权。全局只能调用一次。组件
组件、逻辑等复用三次以上(包含三次),必须解耦抽复用。组件
每页面还原度无重度 BUG,例如文字颜色尺寸明显错误。区域高度设置不正确css
样式使用BEM命名规则。使用驼峰写法。命名规范如下
不得
项目
不得修改项目模版固定规则,规则包含目录结构,路由结构,请求类等。
应该
项目
应该遵守git 提交规范。JS
应该通过 ts,eslint 规则检查。- 接口返回的云服务器图片经过裁剪使用
- 网络速度 4m/s 的情况下,每页首屏加载速度 1s 以内。
- Javascript 编码规范
- HTML 编码规范
- CSS & Sass 编码规范
- react 编码规范
- 项目目录结构规范 修订中...
不应
JS|CSS
所有代码层级不应大于 3 层。包括不限于 css,js。
可选
- 输入框设定最大长度。
- 标题和文章添加超出隐藏或三点省略。
- 所有页面包含加载动画。
- 页面切换有柔和动画。
代码评审标准
- 必须与不得规范全部满足、中级规范不影响功能为优秀
- 主体规范违反一条为警告
- 主体规范违反一条以上为不合格