天天看点

编码规范

1.命名规范

变量名 

    驼峰式,动词开头,首单词首字母小写,后面的单词首字母大写。尽量见词达意。 

    private级_前缀。

常量名 

    全部大写

    函数名(不包含action) 

    public级驼峰式,动词开头,首单词首字母小写,后面的单词首字母大写。 

    private级驼峰式,_前缀,动词开头,首单词首字母小写,后面的单词首字母大写。

文件名 

    所有单词首字母均大写。 

    暂以文件名首单词区分包。

2.注释规范

文件级别 

    作者,日期,所属包。

函数级别 

    作者,日期,函数作用,参数(重要),返回值。

函数内部级别 

    提示代码段的作用即可。 

    维护人员应标注自己修改的段落。

3.mysql规范

命名 

    表名不应出现没有前缀。 

    字段名使用_分割,长度不应过长。

字段类型 

    选择能预估的最小类型。

索引 

    所有外键统一加索引,where中使用量大的加索引。

php端写法 

    单表查询时可以选用AR或者QB写法。 

    多表查询时使用QB写法。 

    增删改使用AR写法。

4.安全规范

js端数据检验

php端数据检验 

    使用model中的rules方式

sql注入防范 

    在编写SQL语句时,要使用绑定数据方式。

xss攻击防范 

    在页面调用变量前使用Html::encode函数。

上传文件规范 

    指明上传文件类型,大小。

编码 

    文件应该使用 Unicode (UTF-8) 编码保存。同时不要使用 字节序标记(BOM),应该使用Unix 格式的行结束符