1.4.代码规范

更新时间：2020-01-19 10:42:24 作者：米拓建站

此规范为MetInfo应用开发代码书写建议，代码总体原则是“使代码清晰易读，整体代码风格要保持一致”。如果有书写代码没有规范的，请参考此文档。

# 代码规范

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

2、所有的 SQL语句的关键词都要大写，如：

SELECT　*  FROM met_applist WEHER no > 1000 ORDER BY no DESC。
	
3、运算符，两边要打空格，如：

if ($a == $b || $c > $f) $c .= $m;
	
4、双引号里面有变量要用{}括起来。如 ：

$a = "你好：{$a}，有什么事情";

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

<table class="display dataTable ui-table" data-table-ajaxurl="{$_M[url][own_form]}a=doindex_json" data-table-pagelength="20">
	
6、数组的键值要用单引号引起来。如 ：

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

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

if ($a > $b) { // 运算符前后有空格, “(”前有空格，“{”前有空格
    	$a = 1; // 运算符前后有空格 
    	$b = 2; // 一个tab的缩进
    } else {// 另起一行，注意else两边有空格
    	$b = 3;
    }
    $i = 0;
    while ($i > 10) {  // 运算符前后有空格, “(”前有空格，“{”前有空格
    	$i++;// 一个tab的缩进
    }
    foreach ($array as $key => $val) {//“(”前有空格，“{”前有空格，“=>”前后后空格
    	$i++;// 一个tab的缩进
    }
    switch ($i) { //“(”前有空格，“{”前有空格
    	case 10://一个tab的缩进
    		$i++;//一个tab的缩进
    	break;//一个tab的缩进
    
    }
	
8、当if语句后面只有一行代码的时候可以不是用{}但是()后面要加空格。如：

if ($a == $b || $c > $f)  $c = $m; //  if 后面有空格
	
9、函数的参数有用“,”（逗号隔开后）要有空格，函数定义的时候“)”与“{”之间有空格。里面的代码也要有一个tab的缩进。

function ceshi($a, $b) {  // “{”前有空格“ $a,”逗号后有空格
    	$a += $b;//一个tab的缩进
    }

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

class metinfo { //“{”前有空格
    	//一个空行
    	public $met;//一个tab的缩进
    	public $met2;
    	//一个空行
    	public function doindex() {//public 不要省略，类的方法内部代码规范同函数//一个tab的缩进
    
    	}
    	//一个空行
    	public function doindex() {//public 不要省略，类的方法内部代码规范同函数
    		
    	}
    }
	
11、代码中有明显功能区别的区块，可以适当加空行，但空行不宜太多。

# 注释规范

> ## 方法的注释（包括类的方法）：

/**                                        //  另起一行
     * 函数作用                                
     * @param  int    $afg      变量作用       //  *后面空一格
     * @param  array  $abbcvbcv 变量作用       //  变量对齐
     * @param  array  $a        变量作用       //  变量作用对齐
     * @param  int    $afff     变量作用       //  int 对齐
     * @return int              返回值作用     //  返回值不用写变量名
     */
     functinon ceshi($a) {
     }
	
1、总的来说，*对齐，整体风格保持一致。

2、/**要新起一行。

3、以/**开头，/与functinon的f对其。

4、以*/结尾，*与functinon的u对其。

5、*/要换行后，在写被注释代码。

6、中间已*开头，*与functinon的u对其。*之后要空一格

7、内容第一行，说明函数作用。

8、第二行开始说明函数参数，@param开头，之后依次说明类型，名称，作用，之间用空格隔开空格。可以适当加TAB，使类型，名称，作用3列对其。之间距离不宜过宽。

9、内容后如果函数有返回值，用@return开头，只用依次是类型，作用。

注意：如果说明的变量取值为固定的几个值。较少可以在一行说明。较多可以新起一行说明，内容较多的情况下也可以。如

/*
     * 函数作用
     *  @param int $a （1=左上角，2=右上角）
     */
	 
或

/*
     * 函数作用
     * @param int $a 
     * 为1时，表示左上角
     * 为2时，表示右上角
     */
	 
 //用作单行注释的时候，直接加载要注释的行后，多行注释的时候，单独起一行。如：
     //多行注释
    a = 1+1;
    b = 2+1;//单行注释
	
> ## 类的注释：

/**                                       // 另起一行
     * 类作用                                 // *后面空一格
     * 类字段注释
     */  
    class a {
         pbulic b; 
    }
	
1、/**,*,*/的使用方法与函数一致,要与被注释的代码开头对其。

2、内容说明类的作用即可。

3、类字段注释写法和函数参数一致。

4、类方法注释写法和函数一致。

文档中心

米拓学堂

帮助中心

在线交流