Web应用开发代码规范以及应用框架核心要素（二）

为合作伙伴创造价值

代码规范：

总体原则：使代码清晰易读。整体代码风格要保持一致。

代码规范：

1.所有类，方法，文件名，链接地址等都要小写。常量要大写。没有强调要大写的，一律小写。(注：只有MetInfo应用框架重要的核心类，方法是大写的，应用中不要使用大写类，方法名称) 2.所有的 SQL语句的关键词都要大写，如：

1 SELECT * FROM met_applist WEHER no < 1000 ORDER BY no DESC。

3.运算符，两边要打空格，如：

1 if ($a == $b || $c > $f) $c .= $m;

4.双引号里面有变量要用{}括起来。如 ：

1 $a = \你好：{$a}，有什么事情\

5.使用echo <<进行块输出的时候，里面的变量也要用{}括起来。

为合作伙伴创造价值

ui-table\

6.数组的键值要用单引号引起来。如 ：

1 $array['key1']['key2']

7.循环、判断语句等，含有{}这种结构的语句。?{?(开始标签)之前要留空格。?(?之前也要留空格。?}?(结束标签)要另起一行，并且与函数类名或语句的关键词对齐，里面的代码块要一个TAB的缩进。

01 if ($a > $b) { // 运算符前后有空格, ‘ (’前有空格，‘ {’前有空格 02 $a = 1; // 运算符前后有空格 03 $b = 2; // 一个tab的缩进

04 } else {// 另起一行，注意else两边有空格 05 $b = 3; 06 } 07 $i = 0;

08 while ($i < 10) { // 运算符前后有空格, ‘ (’前有空格，‘ {’前有空格 09 $i++;// 一个tab的缩进 10 }

11 foreach ($array as $key => $val) {//‘ (’前有空格，‘ {’前有空格，‘ =>’前后后空格 12 $i++;// 一个tab的缩进 13 }

为合作伙伴创造价值

14 switch ($i) { //‘ (’前有空格，‘ {’前有空格 15 case 10://一个tab的缩进 16 $i++;//一个tab的缩进 17 break;//一个tab的缩进 18 19 }

8.当if语句后面只有一行代码的时候可以不是用{}但是()后面要加空格。如：

1 if ($a == $b || $c > $f) $c = $m; // if 后面有空格

9.函数的参数有用“，”（逗号隔开后）要有空格，函数定义的时候“）”与“{”之间有空格。里面的代码也要有一个tab的缩进。

1 function ceshi($a, $b) { // ‘ {’前有空格 $a， 逗号后有空格 2 $a += $b;//一个tab的缩进 3 }

10.类定义“{”之前要有空格，属性，方法之间要有一个空行。里面代码要有一个tab的缩进

01 class metinfo { //‘ {’前有空格 02 //一个空行

03 public $met;//一个tab的缩进 04 public $met2; 05 //一个空行

06 public function doindex() {//public 不要省略，类的方法内部代码规范同函数//一个tab的缩进

为合作伙伴创造价值

07 08 }

09 //一个空行

10 public function doindex() {//public 不要省略，类的方法内部代码规范同函数 11 12 } 13 }

11.代码中有明显功能区别的区块，可以适当加空行，但空行不宜太多。

注释规范：

方法的注释（包括类的方法）： 01 /** // 另起一行 02 * 函数作用

03 * @param int $afg 变量作用 // *后面空一格 04 * @param array $abbcvbcv 变量作用 // 变量对齐 05 * @param array $a 变量作用 // 变量作用对齐