Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 1.14 KB

文件规范.md

File metadata and controls

40 lines (24 loc) · 1.14 KB

坚持一致性的原则。 一个团队的代码风格如果统一了,首先可以培养良好的协同和编码习惯,其次可以减少无谓的思考,再次可以提升代码质量和可维护性。 统一的代码风格,团队内部阅读或编辑代码,将会变得非常轻松,因为组员都用一致思维环境。

##命名规则 ###项目命名 项目名全部采用小写方式, 以中划线分隔。 比如: my-project-name

目录名

目录名参照上一条规则

###JavaScript文件命名 所有js文件名,默认全小写。 如果由多个单词组成时,采用驼峰方式,比如说:userService 对象类型则 首字母大写,账号模型文件 AccountModel.js

###CSS,SCSS文件命名 多个单词组成时,采用中划线连接方式,比如说:retina-sprites.scss

###HTML文件命名 多个单词组成时,采用中划线连接方式,比如说: error-report.html

##编码 UTF8

##缩进

使用tab来进行缩进,可以在IDE里进行设置
js 使用4个 空格,html、css、less 用两个空格 ##待办事项

用 TODO 标示待办事项和正在开发的条目