概述

欢迎使用前端代码规范,使用过程中如碰到问题,请加入我们的QQ聊天群: 603661950

关于

前端代码规范 是由中国教育在线前端团队整理,基于 W3CMDN 等官方文档,并结合团队日常业务需求以及团队在日常开发过程中总结提炼出的经验而制定。

旨在增强团队开发协作、提高代码质量和打造开发基石的编码规范,

以下规范是团队基本约定的内容,必须严格遵循。

HTML规范

结合团队业务和开发过程中总结的规范约定,让页面HTML代码更具语义性,保证代码的一致性和高效性。

图片规范

了解各种图片格式特性,根据特性制定图片规范,包括但不限于图片的质量约定、图片引入方式、图片合并处理等,旨在从图片层面优化页面性能。

CSS规范

统一规范团队 CSS 代码书写风格和使用 CSS 预编译语言语法风格,提供常用媒体查询语句和浏览器私有属性引用,并从业务层面统一规范常用模块的引用。

JS规范

包括原生JavaScript书写规范,还有公司常用框架,库的规范,包括jQuery书写规范,Sencha touch规范和React规范。

命名规范

目录图片HTML/CSS文件ClassName 的命名等层面约定规范团队的命名习惯,增强团队代码的可读性。

API规范

前后端分工明细,规定一套公司通用的API规范,明确前后端开发人员必须遵守的策略。

页面模板

当启动一个前端项目,套用固定模板,保证对应css,js,字体等文件存放目录,规范初始化html文件代码,规范全局css。

常用插件,库地址

常用JS插件,库地址,包含历史版本文件地址,方便使用。

trs系统相关

由于历史原因,有区别于其他项目的页面模板,还包括trs页面公用头部,公用底部的代码片段,单独为trs系统开通的音乐,视频存放地址。