PHP编程规范-优快云博客

没有规矩,不成方圆.

1 命名规范

1.1类

类名首字母大写

class Myz

1.2常量

常量名全部大写,字母间用下划线分隔

$ROOT_PATH = ‘/abc/def’;

1.3变量

第一个单词首字母小写,其余首字母大写

$myBookStore

1.4函数

这个和变量相同

function myFuncDo

2 注释

2.1/**/注释

/**

* 这个是块注释,使用zend studio时,输入/**后回车就可以出来

* 最好是先写函数,写完之后,再在上面写/**,

* 回车后,会看到注释里已经写好了关于下面函数的简单内容了

2.2//注释

//这个注释很随意,跟在某一句后面即可.

2.3我的注释

这个是php文件开头注释:

/**

* @name newpdo.class.php

* @date Thu Sep 13 23:02:36 CST 2007

* @copyright 马永占(MyZ)

* @author 马永占(MyZ)

* @link http://blog.youkuaiyun.com/mayongzhan/

这个是类中函数注释:

/**

* execute a perpare query

* @param mix(array $arrayE,void)

* @return boolean

* @package myz.class.myzPDO

* @version 1.0

3 文件结构

3.1文件的结构清晰,可以对以后维护和使用提供方便

3.2 zend framework的部分结构规则
zf的规则的思想是按照mvc制定的

/view

/control

/model

index.php

3.3我的规则

我习惯于下面的方式

/ 根目录下的文件是控制层的文件和index文件

/adodb

/smarty

/zend

/lib 这里存放我的类或函数或共用文件

/templates 模板

/css 样式

/images 图和flash

/cache 缓存 777

/templates_c 编译后的模板 777

/temp 临时 777

/upload 上传的东西 777

/admin 管理,比如后台

3.4公司规则

这个不方便提供,不过是上面两种的混合,怎么混合?当然是怎么整齐怎么来了啊!

4 文件命名

4.1文件命名目前我没有什么心得都是跟着现有资料和感觉走

比如命名类是myz.class.php

类:myz.class.php

函数myz.func.php

共用文件myz.inc.php

配置文件myz.cfg.php

模板文件myz.tpl.html

文件的名字尽量和文件的内容相对应.尽量全部小写.

5文件内部结构

5.1类

我习惯于{}都占一行

class Myz

{

//begin here

}

5.2函数

同类,里面的两个参数用,格开,并且,后面有一个空格

function myzFun($myz, $myz2)

{

//begin here

}

5.3赋值

前后各空一个空格

$myz = ‘马永占’;

5.4比较

同赋值

$myz > $myz2

5.5控制语句

If 后面空一个空格,()后面空一个空格,{占用和if一行.}单独一行,其他的类似

if () {

//begin here

}

elseif () {

//elseif begin here

}

else {

//else begin here

}

while ($myz = ‘马永占’) {

//while begin here

}

For ($i; $i < 1; $i++) { //这里的$总忘记写…呵呵

//for begin here

}

OK,规则其实很多,这里只做最简单的规范,其他的比如缩进,换行,用法挺多.建议还是照着一定的规律使用.只要能让自己和别人看的清楚就行了.

对了尽量不要使用中文命名程序中的东西和可以传递的内容,实际当中中文问题很多的.使用GBK UTF8时中文问题还是很多.今天就遇到了传递get参数超过两个中文时出现乱码的问题.最后是在数据库里添加了英文缩写的字段才解决的.大家可以试一下编码后传递.

关于规范大家可以在网上搜一下,有一份叫东软C#编程规范的文档,其他的很少见到.有其他的话,回复我一下,我想看看,谢谢啦.

php编码规范