实用文档
WEB前端代码规范
规范目的
为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护,输出高质量的文档,特制订此文档。本规范文档一经确认,前端开发人员必须按本文档规范进行前台页面开发。本文档如有不对或者不合适的地方请及时提出,经讨论决定后方可更改。
基本准则
符合web标准;语义化html;结构、表现、行为分离;兼容性优良。页面性能方面,代码要求简洁明了有序,尽可能的减小服务器负载,保证最快的解析速度。
文件规范
1. Html,css,js,images文件均归档至相应约定的目录中。 cssimagesbackStagejs后台模块……cssWebRootimagesfrontStagejsWEB-INF前台模块……全局公共模块…… 2. html文件命名:英文驼峰式命名,文件名.html。按实际模块需求命名。 文案大全
实用文档
3. jsp文件命名:英文驼峰式命名,文件名.jsp。按实际模块需求命名。
4. css文件命名:英文驼峰式命名,文件名.css。共用base.css,首页index.css,其他页面按实际模块需求命名。 5. js文件命名:英文驼峰式命名,文件名.js。共用common.js,其他依实际模块需求命名。
html书写规范
1. 文档类型声明及编码: 统一为html5的声明类型;编码统一为
...之间引入,选择link方式引入而非
@import形式。 3. 非特殊情况下js文件必须在页面底部引入。
4. 引入样式文件或JavaScript文件时,须略去默认类型声明,写法如下:
... ),hr(
)等;属性值必须用双引号包括。 9. 充分利用无兼容性问题的html自身标签,比如span、em、strong、optgroup、label…… 10. 需要为html元素添加自定义属性的时候,首先要考虑下有没有默认的已有的合适标签去设置,如果没有,须以\为前缀来添加自定义属性,避免使用\:\等其他命名方式。 文案大全
实用文档
11. 语义化html,如标题根据重要性用h1-h6(同一页面只能有一个h1),段落标记用p,列表
用ul,内联元素中不可嵌套块状元素。 12. 尽可能减少div的嵌套层数。
13. 在页面中尽量避免使用内嵌样式表,即在标签内使用style=\…\。
14. 以背景形式呈现的图片,尽量写入css样式中;重要图片必须加上alt属性;
15. 特殊符号使用:尽可能使用代码替代:比如<(<)、>(>)、空格( )、&(&)、
”(")等等; 16. 尽量避免使用过度复杂的HTML结构。
css书写规范
1. 编码统一为utf-8。
2. 为了避免一些浏览器兼容性问题以及增加样式重用性,每个页面必须引入base.css(详见
附件一),此文件不可随意修改。 3. class与id的使用:id是唯一的并是父级的,class是可以重复的并是子级的,所以id
仅使用在大的模块上,class可用在重复使用率高及子级中。 4. 为JavaScript预留钩子的命名,请以js_起始,比如:js_hide,js_show。
5. class与id命名:使用英文命名,命名要语义化,简明化,但不要使用诸如first,last
之类的命名。使用驼峰式和下划线分隔相结合的命名规则,即命名应以父级加子级的命名规范,
如:父级的类为simple 子级的类应该为simple_first,以此类推,但是尽量避免出现超过四级的类命名。
6. css属性书写顺序,建议遵循:自身属性-->布局定位属性-->文本属性-->其他属性。此条
可根据自身习惯书写,但尽量保证同类属性写在一起。
属性列举: 自身属性主要包括:width、height、margin、padding、border、background; 布局定位属性主要包括:display、list-style、position(相应的top、right、bottom、left)、float、clear、visibility、overflow; 文本属性主要包括:color、font、text-decoration、text-align、vertical-align、 white-space 文案大全