WEB开发编码规范
Skylin 在上一个公司的时候,公司在技术规范方面比较欠缺,所以要我写一份关于WEB开发的编码规范,下面我就简单的说下。
编码采用如下约定
1) 所有客户端脚本一律使用javascript
2) 所有html一律使用 (table或div) + css
3)在提交表单的同时必须首先使用javascript进行客户端表单数据验证,然后在提交给后台PHP程序进行再一次验证
4)代码必须使用缩进格式,缩进空格必须等于或大于3个
Html规范
一行不能有多于一个的标签存在
Css必须使用单独的样式文件存储
Html文件与css文件各部分需要有注释,解释各部分的含义(注释可以用中文或英文)
4)html注释用例
<!– 某功能 开始 –>
<div>
<p></p>
<p></p>
<p>
<span>Hello</span>
</p>
</div>
<!– 某功能 结束 –>
5)css注释用例
Css命名需要表现出相关含义(英文命名或拼音命名)
/* 某功能 开始 */
* {
font-size:12px;
text-decoration:none;
}
/* 某功能 结束 */
Javascript规范
一行不能有多于一条的语句存在
Javascript函数与相关赋值操作必须使用单独的js文件存储
类,函数与变量命名需要表现出相关含义(英文命名或拼音命名)
Javascript各部分和函数,类必须有注释说明(注释可以使用中文或英文)
Javascript注释用例
/**
* @作者:测试
* @版权:测试
* @类描述:测试
* @参数 obj:某个对象
*/
function User(obj)
{
}
/**
* @作者:测试
* @版权:测试
* [...]
Posted in 闲聊 |
No Comments »