“二级栏目 - 一级栏目 - 网站名称”。
CSS规范
1. 编码统一为utf-8;
2. 公用文件:协作开发过程中,会引入默认的base.css(里面包括了css reset、常用的css间距,css字体,css大小等,详细参见base.css);
3. class与id命名: ,样式名称由 小写英文 、 数字 和_来组合命名, 如i_comment, fontred, width200; 避免使用中文拼音, 尽量使用简易的单词组合;命名要语义化, 简明化。
4. 为JavaScript预留钩子的命名, 尽量使用id属性,可以更快的获取到dom。
5. 书写代码前, 考虑并提高样式重复使用率;
6. 背景图片请尽可能使用sprite技术, 减小http请求, 考虑到多人协作开发, sprite按模块制作;
7. 必须为大区块样式添加注释, 小区块适量注释;
8. 代码缩进与格式: 建议单行书写, 可根据自身习惯, 后期优化会统一处理;
JavaScript规范
1. 文件编码统一为utf-8, 书写过程过, 每行代码结束必须有分号; 原则上所有功能均根据XXX项目需求原生开发, 以避免网上down下来的代码造成的代码污染(沉冗代码 || 与现有代码冲突 || …);
2. 库引入: 原则上仅引入jQuery库, 若需引入第三方库, 须与团队其他人员讨论决定;
3. 变量命名: 驼峰式命名. 原生JavaScript变量要求是纯英文字母, 首字母须小写, 如iTaoLun;
4. 另, 要求变量集中声明, 避免全局变量.
5. 类命名: 首字母大写, 驼峰式命名. 如ITaoLun;
6.函数命名: 首字母小写驼峰式命名. 如iTaoLun();
7. 命名语义化, 尽可能利用英文单词或其缩写;
8. 尽量避免使用存在兼容性及消耗资源的方法或属性, 比如eval_r() & innerText;
9. 后期优化中, JavaScript非注释类中文字符须转换成unicode编码使用, 以避免编码错误时乱码显示;
10. 代码结构明了, 加适量注释. 提高函数重用率;
11. 注重与html分离, 减小reflow, 注重性能.
注释规范
1. html注释: 注释格式 , ‘–’只能在注释的始末位置,不可置入注释文字区域;
2. css注释: 注释格式 ;
3. JavaScript注释, 单行注释使用’//这儿是单行注释’ ,多行注释使用 ;
开发及测试工具约定
建议使用WebStorm||Aptana || Dw || Vim , 亦可根据自己喜好选择, 但须遵循如下原则:
1. 不可利用IDE的视图模式’画’代码;
2. 不可利用IDE生成相关功能代码, 比如Dw内置的一些功能js;
3. 编码必须格式化, 比如缩进;
其他规范
1. 开发过程中严格按分工完成页面, 以提高css复用率, 避免重复开发;
2. 减小沉冗代码, 书写所有人都可以看的懂的代码. 简洁易懂是一种美德. 为用户着想, 为服务器着想.