高世军的博客

人生的意志和劳动将创造奇迹般的奇迹!

编码规范(二)之命名规范


1.变量命名

    PHP中的变量用一个美元符号后面跟着变量名表示。变量名区分大小写。一个有效的变量名由字母或者下划线开头,后面跟着任意数量的字母、数字或者下划线。不应该在变量名中使用中文等飞ASCII字符。

 1)程序整体

    程序整体以驼峰法命名,以小写字母开始,同时命名要有意义:

    FunctiondisplayName($name){echo $name;}

2)PHP全局变量键值

     PHP全局变量键值两边都有“_”,中间使用驼峰法命名,如:

    $_GLOBAL[‘_beginTime_’];

3)普通变量

     普通变量整体采用驼峰法,建议在变量前加表示类型的前缀。不确定类型的以大写字母开头,函数参数不确定的类型以大写字母开头,其他地方的变量以小写字母开头,对于一些常见的变量,按照约定命名,并避免使用常见关键字或存在模糊意义的单词,变量应该以名词为主。

4)函数名

     函数名既要有意义,一看就知道是什么,也要尽量缩写,建议使用动词或者动词加形容词的命名方式。

5)类中的属性

    类中的属性变量遵守普通变量的命名规则。

2. 类及接口命名

    在面向风格的代码中,其命名方式有一些悬殊,类的命名遵循如下规则:

    1) 以大写字母开头

    2)多个单词组成的变量名,单词之间不用间隔,各个单词首字母大写。

    3)类名与类文件保持一致。

    4)抽象类应该以Abstract开头。

    类中的方法和函数采用同样的命名规则:

    接口命名规则遵循如下规则:

    1)采用和类相同的命名规则,但其在命名前i字符,表示接口。

    2)尽量保持和实现它的类命名一致。

3. 数据库命名

   在数据库相关的命名中,一律不出现大写。命名规则如下:

    1)数据表的命名规范

    表名均使用小写字母

    表名字使用统一的前缀,且前缀不能为空

    对于多个单词组成的表名,使用“_” 间隔。

    2)表字段命名遵循如下规则:

    全部小写字母命名

    多个单词不用下划线进行分割

    如果有必要,给常用字段加上表名首字母作为前缀

    避免使用关键字和保留字,但约定俗成的除外

   3)存储过程、触发器、event以及视图的命名在表的命名规则的基础上,遵循以下规则:

                     存储过程以proc_开头

                     触发器以tri_开头

                     Event调度以event_开头

                     视图以view_开头

4.  习惯与约定

通常变量的命名应该是有意义的单词,但在循环体中的临时变量采用“IN规则”。

1) 缩写

Image——img

String——str

Database——db

Array——arr

Count——cnt

Temporary——temp或tmp

Password——pwd或passwd

Message——msg

5. 魔术数字

数值需要变动时,只需要更改一个地方。

例如:

$price_tax=1.05*price;

应写成:

Define(Tax,1.05);

$price_tax= TAX*price;

 

阅读更多
个人分类: 编码规范
想对作者说点什么? 我来说一句

没有更多推荐了,返回首页

不良信息举报

编码规范(二)之命名规范

最多只允许输入30个字

加入CSDN,享受更精准的内容推荐,与500万程序员共同成长!
关闭
关闭