关于代码开发规范和原则

在集体协作的今天，规范的形成有利于提升协同开发的效率，以及代码后期的维护和调优，鉴于以前在开发的时候对代码开发及规范的忽视，有必要用这些规范来更正以前的一些“不良”的代码编辑习惯：

１，函数注释：

以前只是简单的注释，例如：

//此函数返回用户具体信息
function return_userinfo($uid)

{
...
return $result;
}

上面是不规范的写法，现在要这样写：

/**
*
*此函数返回用户的具体信息
*
*@param int $uid 用户UID
*@return array $result
*/
function return_userinfo($uid)
{
...
return $result;
}

2，调试阶段：

所有临时性、调试性、试验性的代码，添加统一的注释标记“//@debug:”，例如：

$num = 1;
$flag = true;// @debug: 测试文件是否加载
if(!flag)
{
//debug statements
}

3，大括号 {}、if 和 switch：

以前的习惯是大括号的前一个括号写在前一行，像这样：

if(...){
...
}

现在要写成：

if(...)
{
...
}

来看看这一系列最标准的写法吧：

if ($condition)
{
switch ($var)
{
case 1:
echo 'var is 1';
break;
case 2:
echo 'var is 2';
break;
default:
echo 'var is neither 1 or 2';
break;
}
}
else
{
switch ($str)
{
case 'abc':
$result = 'abc';
break;
default:
$result = 'unknown';
break;
}
}

除此之外还有很多的规范有待学习，上面列出的只是感觉和以前的书写习惯大不一样的。

规范文档要多多看才对！