红满堂前端开发规范

一.代码结构规范(结构和行为分离):

1.html, css, js代码分别放在各自的文件里.

2.在html文件body之前引入css

3.在html文件body里的最下面引入js

4.html代码里不要出现onclick等html dom事件,统一使用js代码触发html dom事件

5.避免使用document.write方法,以方便结构和行为分离.

6.每一大段html代码加一条html注释解释该段代码的作用,不要过多,也不能没有

7.每一个js函数都要添加注释,如下:

/*

*@function 验证邮箱格式

*@author 你的昵称或者全名

*@params 参数类型列表,如: userid(int),money(float)

*@return 函数返回类型,如: totalMoney(float)

*/

二.命名规范

1.文件命名(html,css,js,图片文件等):不要出现中文!不要出现中文!不要出现中文!

2.html代码少用或者不用id,避免团队开发中id冲突的问题.除非确定此id只在该页面出现一次.

3.css类名统一使用”-“横杠分割单词,单词全都是小写.

4.所有命名都要具有可读性,统一使用英文命名,不能出现中文或者是拼音,不要有错别字,不懂的单词一定要查字典再使用,不能单凭自己揣度.

 

前端开发规范 V 0.10 版,有待完善

发表评论