一、说明
规范的制定是我们长期以来对工作的积累与沉淀的产物,帮助我们更快、更好、更高效的完成繁重、复杂、多样化的任务,我们制作规范的主要目的在于:
- 降低每个组员介入项目的门槛成本
- 提高工作效率及协同开发的便捷性
- 高度统一的代码风格
- 提供一整套HTML、CSS解决方案,来帮助开发人员快速做出高质量的符合要求的页面
最终实现:
不管有多少参与者,代码都应该像同一个人所写。
始终同意并遵循规范的每一条内容 ,不对之处,请随时指出,便于及时修改。
**
http://alloyteam.github.io/CodeGuide/
二、命名规范
文件命名
- 文件名统一小写
- 单词与单词件使用-连接,如果是插件,可以用.连接,如jquery.fileupload.js
其他命名
- 除了js中存在驼峰命名和其它方式的命名外,其它一律使用-连接单词,且单词都为小写,单词尽量短但必须保持明确的意义,如btn可取代button,但s并不能表示任何意义
- 上述规则同样适用于html属性
- 不允许使用拼音(约定俗成的除外,如:youku,baidu)
三、HTML规范
四、CSS规范
五、javascript规范
六、项目结构
项目名称为marketing(营销),项目基本结构如下:
.marketing
├─ css
│ ├─ mui.min.css
│ └─ mui.css
└─ fonts
│ └─ mui.ttf
└─ images
│ └─ logo.png
└─ js
│ └─ mui.min.js
└─ pages
│ └─ my.html
└─ index.html
│
└─ manifest.json