前端规范
程序员文章站
2022-06-27 19:34:18
...
最近,新的项目基本开发完成了。开发过程中发现前端有点乱。于是有了下文。
命名:
1:首字母小写,方法面尽量与所实现的功能相匹配,做到看方法名就能大概的了解该方法的含义。
2:文件名类不带特殊标点符号,采用大小写形式。
js方面:
1:页面上原则上不出现任何js方法,或逻辑代码,所有的代码写在js文件中。
2:页面上提交表单采用ajax方法提交。
3:所有查询采用ajax查询,局部刷新。
4:常用的验证如:数字,为空,邮箱等方法写在公用的js文件中处理。
5:提供公用的js插件,如:弹窗,提示框,下拉,输入框等
6:按一个显示文件一个js文件对应。
7:引入新的组件需要讨论并通过测试组同事对监容等方面测试通过后,方可引入。
8:所用页面引用的框架类的js文件通过include方式引入,原则上优先采用cdn加速方式引入。(http://www.bootcdn.cn/)
9:每个方法名上面尽量增加注释说明。
10:标签上原则上不出现,onclick,onblue该类方法.尽量在js文件中处理绑定事件。
html方面:
1:编写的html标签符合w3c标准,如正常闭包,等一定要正确。不出现<br/>这类格式样式。
2:所有的html标签默认小写。不能出现大小写混搭。
3:input,这类标签尽量在td,li,div内部
4:如自定义属性采data-*的方式
5:所有img,a,botton这类按钮类标签一定要增加 title,alt提示
css方面:
1:原则上所用的样式要写在单独的css文件中。
2:标签内不允许通过style,width,height这些属性设置,所有的设置在css文件中体现。
其它:
1:目前结构明确,如:image,js,css 所有的类型文件应放在文件夹目录下。
2:前台页面展示是否采用jsp+jstl,freemark或其它(需要讨论)。不能出现任何java代码。
3:页面格式整洁,严格注意闭包。
4:所有的文件头部要包含title,keyword,说明等属性。
命名:
1:首字母小写,方法面尽量与所实现的功能相匹配,做到看方法名就能大概的了解该方法的含义。
2:文件名类不带特殊标点符号,采用大小写形式。
js方面:
1:页面上原则上不出现任何js方法,或逻辑代码,所有的代码写在js文件中。
2:页面上提交表单采用ajax方法提交。
3:所有查询采用ajax查询,局部刷新。
4:常用的验证如:数字,为空,邮箱等方法写在公用的js文件中处理。
5:提供公用的js插件,如:弹窗,提示框,下拉,输入框等
6:按一个显示文件一个js文件对应。
7:引入新的组件需要讨论并通过测试组同事对监容等方面测试通过后,方可引入。
8:所用页面引用的框架类的js文件通过include方式引入,原则上优先采用cdn加速方式引入。(http://www.bootcdn.cn/)
9:每个方法名上面尽量增加注释说明。
10:标签上原则上不出现,onclick,onblue该类方法.尽量在js文件中处理绑定事件。
html方面:
1:编写的html标签符合w3c标准,如正常闭包,等一定要正确。不出现<br/>这类格式样式。
2:所有的html标签默认小写。不能出现大小写混搭。
3:input,这类标签尽量在td,li,div内部
4:如自定义属性采data-*的方式
5:所有img,a,botton这类按钮类标签一定要增加 title,alt提示
css方面:
1:原则上所用的样式要写在单独的css文件中。
2:标签内不允许通过style,width,height这些属性设置,所有的设置在css文件中体现。
其它:
1:目前结构明确,如:image,js,css 所有的类型文件应放在文件夹目录下。
2:前台页面展示是否采用jsp+jstl,freemark或其它(需要讨论)。不能出现任何java代码。
3:页面格式整洁,严格注意闭包。
4:所有的文件头部要包含title,keyword,说明等属性。
上一篇: 简单工厂、工厂方法和抽象工厂的总结
下一篇: EF 更新部分字段写法