<?php
妈妈咪呀php程序编码规范
1. 变量命名
采用“驼峰式”命名,只允许由数字或字母组成,下划线是不允许的,首字母要小写,其后每个单词首字母要大写,
变量名尽量表达详细,函数名,方法名,数组键名,都遵循此原则,
例如:
$userHeadThumb
2. 常量命名
常量 constant 必须仅包括字母,数字和下划线,而且必须全部大写,各个单词之间用下划线分割.
例如 :
"MY_CONSTANT_ONE" // 是允许的
"MYCONSTANTTWO" // 不允许的
"my_constant_two" // 不允许的
3.字符串
多个字符串必须用点号 "." 来连接,且字符串与点号间必须用一个空格隔开.
例如 :
$company = 'Zend' . 'Technologies';
变量替换中的变量 {$变量名} 的形式.
例如 :
$greeting = "Hello {$name}, welcome back!"; // 允许
当用点号 "." 连接各字符串的时候,我们允许把它分割成多行以增强可读性.在这种情况下,点号 "." 必须与等于号 "=" 对齐.
例如 :
$sql = "SELECT `id`, `name` FROM `people` "
. "WHERE `name` = 'Susan' "
. "ORDER BY `name` ASC ";
4. 数组
当使用 array 类型符声明关联数组的时候,我们鼓励把它分成多个行,同时保证每行的键与值的对齐,以保持美观,,
数组键名命名规范和 变量命名规范一致.
例如:
$arrUsers = array(
'userId' => 1,
'userName' => '涵涵girl',
'userHeadThumb' => 'sweet_girl.img'
);
x. 缩进
不用tab制表符,用4个空格替代
当有多行声明变量或变量赋值时,请进行等号对齐,等号右边空一格,保持好的可读性
例如:
$commentType = intval($commentType);
$userId = intval($userId);
$commentId = intval($commentId);
$posterId = intval($posterId);
x. 函数
函数名采用“驼峰式”
大括号在函数名称后面,不另起一行
例如:
function getGirls(){
,,,
}
参数不易过多,否则请用数组方式传送,
函数不易过大过长,过长请进行拆分
x. 注释
每个函数,类 请都以下面方式注释
/**
*
* 函数add,实现两个数的加法
* 一个简单的加法计算,函数接受两个数a、b,返回他们的和c
*
* @param int 加数
* @param int 被加数
* @return integer
*
* author whh
* time 2010/10/12
*/
function add($a, $b) {
return $a+$b;
}
单行注释
// ,不使用 /**/
在代码编写中请尽量填写注释,需用语准确,避免含糊其辞,模棱两可,一词多义的情况
x. 类
方法必须总是用 private,protected 或者 public 来声明其作用域.
例如 :
class foo{
function goo()
{
// 不允许的
}
private function bar()
{
// 正确
}
protected function baz()
{
// 正确
}
public function zoo()
{
// 正确
}
}
x. 文件名
多个单词间用下划线连接
例如:
add_photo.php
ajax_add_photo.tpl
此处采用“驼峰命名”是不允许的
x. 其他
所有代码都必须用4个空格来进行缩进.
在条件控制语句的条件括号内,必须用空格将操作符与其它元素隔开.如果遇到很长的逻辑判断,则鼓励用内嵌括号来分割各个逻辑.
例如 :
if (($a != 2) and ($b == 1)) {
$a = $b;
}
foreach($arr as $param){
,,,
}
// 用 "{}" 定界内容是正确的
if ($a != 2) {
$a = 2;
} else if ($a == 3) {
$a = 4;
} else {
$a = 7;
}
// 没有用 "{}" 定界是错误的
关键词 "global" 是不允许使用的,请用 $GLOBAL[xxx] 替代.
每行代码长度应控制在80个字符以内,最长不超过120个字符.
在一个页面,一个函数或方法内,对于$_POST,$_GET,$_REQUEST 请在第一次使用时赋值给一个变量,避免在多个地方的代码中使用它们
保持开发工具的统一
编码规范
最新推荐文章于 2022-08-23 17:11:03 发布