php代码编写规范.doc

代码规范
1. 代码标记
统一使用做为开始结束标记，不允许使用短标记。
2. 命名规范
制定统一的命名规范对于项目开发来说非常重要，不但可以养成程序员一个良好的开发习惯，还能增加程序的可读性、可移植性和可重用性，还能很好的提高项目开发的效率。
名字就是事物在它所处的生态环境中一个长久而深远的结果。总的来说，只有了解系统的程序员才能为系统取出最合适的名字。如果所有的命名都与其自然相适合， 则关系清晰，含义可以推导得出，一般人的推想也能在意料之中。
就一般约定而言，类、函数和变量的名字应该总是能够描述让代码阅读者能够容易的知道这些代码的作用。形式越简单、越有规则，就越容易让人感知和理解。应该避免使用模棱两可，晦涩不标准的命名。(使用相同含义的英文命名)
2.1文件
文件命名都使用驼峰命名法，并且第一个单词首字母小写，类文件以.class.php为后缀。例如：userAction.php userAction.class.php
2.2变量
变量命名分为普通变量、静态变量、局部变量、全局变量等方面的命名规则
a.所有字母都使用小写
b.对于一个变量使用多个单词的，使用下划线“_”作为每个词的间隔。
例子：$user_name
2.3常量
常量命名所以字母大写，多个单词之间用下划线“_”分隔。
2.4函数
函数所有字母小写，多个字母之间用下划线“_”分隔
例子：function get_user_ip()
2.5类
a.以大写字母开头；
b.多个单词组成的变量名，单词之间不用间隔，各个单词首字母大写。
例子：class MyClass 或class DbOracle等。
2.6类属性
属性的命名使用驼峰法，首字母小写或者使用下划线"_"，以下划线开头的属性属于私有属性。
例子：$userName,而$_instance属于私有属性
2.7类方法
方法的命名使用驼峰法，首字母小写或者使用下划线"_"，以下划线开头的方法性属于私有方法。
例子：public function getUser()
private function _getUser() 则为私有方法
3. 编码规范
3.1代码缩进
统一缩进四个空格，可以用Tab缩进，但是要保证每一个Tab都是四个空格。
3.2运算符、小括号、空格和函数
每个运算符与两边参与运算的值或表达式中间要有一个空格，字符连接运算符号两边不加空格，在循环控制语句条件也可以不加；
左括号“(” 应和函数关键词紧贴在一起，右括号“)”除后面是“)”或者“.”以外，其他一律用空格隔开它们；
除字符串中特意需要，一般情况下，在程序以及HTML中不出现两个连续的空格；
任何情况下，PHP程序中不能出现空白的带有TAB或空格的行，即：这类空白行应当不包含任何TAB或空格。同时，任何程序行尾也不能出现多余的TAB或空格。多数编辑器具有自动去除行尾空格的功能，如果习惯养成不好，可临时使用它，避免多余空格产生；
每段较大的程序体，上、下应当加入空白行，两个程序块之间只使用1个空行，禁止使用多行。
程序块划分尽量合理，过大或者过小的分割都会影响他人对代码的阅读和理解。一般可以以较大函数定义、逻辑结构、功能结构来进行划分。少于15行的程序块，可不加上下空白行；
函数定义调用时逗号与后面的参数之间空一格。
例子：
$result = (($a + 1) * 10).'string';
$test = (1 == 1) ? true : false;
function fun($key, $value) {
}
3.3语句
一个基本原则，每一行只写一条语句。
Sql语句一行写得下时写一行，一行写不下时按如下写法：
SELECT a.filed1, b.field2,b. field3
FROM tablea a LEFT JOIN tableb b ON a.filed1 = b.field2
WHERE a.field1 = 1
ORDER BY a.filed1
所有sql关键字大写
条件语句
if(true) {
} else {
}
循环控制语句
for($i=0; $i<
4. 代码注释
每一个代码编写者都应该养成良好的注释习惯。好记性不如烂笔头，给每一段代码加上必要的注释，方便日后阅读。在团队开发中犹为重要，良好的注释利于其他开发人员更快的理解代码。
单行统一用//，多行使用/**/
4.1文档注释
每一个php文档都应该在开始加上注释，简单说明该文档的功能。
例子：
/**
* 文件描述
* @copyright 版权
*@file 文件名
* @author 作者
* @create 创建日期
* @version 版本
*/
4.2函数注释
/**
* 描述
* @param 参数名 含义
* @param 参数名 含义
* @return 返回值
*/

4.3变量，常量，类属性注释
一般在声明后紧跟注释
例子：
$user_name = 'lucifer'; //用户名
define(' DEBUG', 1); //是否开户调试
class Test
{
private $_id; //ID
}