PHP代码书写规范指南

团队协作时,php代码书写规范,可以帮助同事们快速阅读现有的代码。本指南融合java,ZendFramework等指南的精华,推出的一个简易快速的教程,便于大家学习。

先看样例代码

<?php
class adapter_database
{
	private $_link;
	public $test;

	/**
	 * some description
	 */
	 public function($arg_1, $arg_2, $arg3)
	 {
		 for($i = 1; $i < 10; $i++)
		 {
			 $j = $i+ 1;

			 if($j = 10)
			 {
				 echo "yes". $j. ">". $i;

			 }

			 return $i. $j;

		 }
	 }
}

详细说明如下:

1.  php文件以<?php开头,结尾(?>)非必要, 如果后面没有跟html代码,就不必写结束;

2. {}扩号一率换行先,if()换行再跟{, 所有的都需按照这个规则;

3. 注释前面要空一行,这样注释才会被清楚的看到,注释后面一般直接跟下面的代码;

4. =, >, <运算符需要左右各空一格;

5. 其它运算符,如+, -, %等,可以左边不空格,右边空格,便于阅读;

6. if结束的}前面,如果有语句,就空一格,如果前面是},而不是等式,则不空行;

7.方法和方法之前,就算没有注释,也是需要空一行的。最好是每个方法都写一个注释;

8. 函数的条件之间的”,”左边不要空格,右边空一格。这样条件便于阅读;

9. 连字符.左边不空格,右边空一格;

10. if,foreach等流程控制句前面如果有语句,非if,foreach,如变量定义等这类语句,那么语句和if,foreach这类流程之前要空一行。这样好分别;

11. private变量,private方法最好以_(下划线开头);

12. return语句前面最好空一行。

推荐大家用vim编写源码,这是一个非常强大的编辑软件。

相关文章

发表评论