培养自己的php编码规范(2)

1、块注释
块注释,个人认为主要用在了三个地方。对php脚本的描述、对一个大的功能模块的描述、在一行之内不能写完注释的时候,也应该放在块注释中

2、行注释
行注释,个人认为他是配合块注释进行工作的!一般用于描述一个大的功能模块的具体细节!

实战的案例

关于phpdocumentor语法的具体使用细节,这里就不多说了,官网上说的再清楚不过了

从上面的例子中我们可以看一下代码的布局大致是怎么回事,但是还需要我们在实践中慢慢摸索

下面附上一些php的编程规范,给大家参考下

一、文件标记:

1.所有php文件,其代码标记均采用完整php标签,不建议使用短标签(短标签容易和xml混淆,php从5.4开始默认不支持短标记)。

2.对于只有php的代码文件,建议省略结尾处的‘?>'。这是为了防止多余的空格或其他字符影        响到代码。

二、文件和目录命名

1.程序文件名和目录名均采用有意义的英文命名,不使用拼音和无意义的字母,只允许出现字母、数字、下划线和中划线字  符,同时必须以‘.php'结尾(模板文件除外),多个词间使用驼峰命名法。

例://类统一采用:DemoTest.class.php

//接口统一采用:DemoTest.interface.php

//其他按照各自的方式:demoTest.{style}.php

三、文件目录结构

规范的目录结构有助于团队协作开发和后期维护。

——app            //独立的应用

——class          //单个的类文件,共用的类文件

——conf/inc    //配置文件或目录

——data          //数据文件或目录

——doc           //程序相关文档

——htdocs       //document_root

——images       //所有图片文件存放路径

——css            //css文件

——js               //js文件

——lib              //共用类库

——template    //模板文件

——tmp            //临时文件目录

——cache    //缓存文件

——session  //SESSION文件

——template_c    //编译后的模板文件

——other

——upload      //上传文件

——manage    //后台管理文件目录

四、命名规范

1.变量命名:php中变量区分大小写,一个有效的变量名由数字、字母或下划线开头,后面跟任意数量的字母、数字、下划线。

a)程序整体以驼峰命名法,以小写字母开始,同时命名要有意义。(function displayName())

b)PHP全局变量键值两边都有‘_',中间用驼峰命名法命名。($_GLOBAL['_beginTime_'])

c)普通变量整体采用驼峰命名法,建议在变量前加表示类型的前缀。不确定类型的以大写字符开头。

d)函数名要尽量有意义,尽量缩写。

2.类及接口命名:

a)以大写字母开头。

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

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

d)程序中所有的类名唯一。

e)抽象类应以Abstract开头。

接口命名规则:

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

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

3.数据库命名:在数据库相关命名中,一律不出现大写。

a)表名均使用小写字母。

b)表名使用同一的前缀且前缀不能为空。

c)对于多个单词组成的表名,使用‘_'间隔。

d)表字段命名规则。

i)全部使用小写字母。

ii)多个单词不用下划线分割。

iii)给常用字段加上表名首字母做前缀。

iv)避免使用关键字和保留字。

五、注释规范

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:http://www.heiqu.com/8a995b9dd1a947ade988e2f19f3fac8a.html