基于php編程規(guī)范(詳解)

更新時(shí)間：2017年08月17日 08:01:02 投稿：jingxian

下面小編就為大家?guī)硪黄趐hp編程規(guī)范(詳解)。小編覺得挺不錯(cuò)的，現(xiàn)在就分享給大家，也給大家做個(gè)參考。一起跟隨小編過來看看吧

今天寫這個(gè)是為了提醒自己編程過程不僅要有邏輯思想還有要規(guī)范代碼這樣可讀性

1、PHP 編程規(guī)范與編碼習(xí)慣最主要的有以下幾點(diǎn)：

1 文件說明

2 function 函數(shù)體說明

3 代碼縮進(jìn)

4 if省略

5 變量規(guī)范

6 命名規(guī)范

7 十行一注釋

8 注釋風(fēng)格

9 開放關(guān)閉原則

2、文件說明個(gè)人代碼 -規(guī)范如下：

<?
/*
 +----------------------------------------------------------------------
 + Title    : 標(biāo)題
 + Author    : 作者
 + Version   : 版本號(hào)
 + Initial-Time : 這個(gè)文件初始創(chuàng)建的時(shí)間
 + Last-time  : 這個(gè)文件最后修改的時(shí)間 + 修改人的名稱
 + Desc     : 這個(gè)文件的簡(jiǎn)單描述
 +----------------------------------------------------------------------
*/

3、Function 函數(shù)體說明：

<?
/**
 * 函數(shù)體簡(jiǎn)單的描述
 * @author_start : 作者
 * @author_end  : 修改時(shí)間 + 修改者
 * @param string : $id    描述
 * @param array : $array 描述
 * @param array : $num  描述
 * @return : 返回值說明
*/
function Test($id, $array = array(), $num = 1){
}

注意:Function里面變量參數(shù)的代碼縮進(jìn)風(fēng)格

4、代碼縮進(jìn)：

<?
$str = 1;
$info = '123';
$version = '123123';
$name = 'test';
$i  = 'haha';
 
# 一般在最外部的if 或流程控制語句都應(yīng)該上下留空一行
if ($info) {
 
}
 
# 一般在最外部的for或者 foreach都應(yīng)該上下留空一行
for ($i=0 ,$i<6 ,$i++){
 
}

5、IF省略

<?
# 一般在if語句與其分支的流程控制語句當(dāng)中,存在這exit或者return的情況下,都應(yīng)該省略其else的部分操作
# 錯(cuò)誤
if () {
  return false;
} else {
  return true;
}
# 正確
if () {
  return false;
}
return true;

6、變量規(guī)范，使用英文命名

<?
# 正確
$title = '標(biāo)題';
$name = '名稱';
$pwd  = '密碼';
# 錯(cuò)誤
$biaoti = '標(biāo)題';
$ming  = '名稱';
$mima  = '密碼';

7、命名規(guī)范

<?
/**
 * 實(shí)際開發(fā)中，命名方式一般有三種情況
 * 注意：不管是類名，變量，方法名，在實(shí)際開發(fā)中，最多只能是不超過3個(gè)單詞的組合
 * 大駝峰 ：每個(gè)單詞首字母大寫
 * 小駝峰 ：中間單詞首字母大寫 
 * 蛇形  ：每個(gè)單詞小寫，單詞與單詞之間使用 _ 符合鏈接
 */
 
# 大駝峰，常用于類名定義
class Car{}
class BlueCar{}
 
# 小駝峰，常用于方法名定義
class Car{
 public function getColor(){}
}
 
# 蛇形，常用于變量名定義
$res_id  = 1;
$res_name = 2;

9、注釋風(fēng)格

<?
1、當(dāng)需要對(duì)某段代碼，做大量描述時(shí)，使用以下注釋風(fēng)格
/**
 * 我是說明
 * ① 流程一
 * ② 流程二
 * ③ 流程三
 */
 
2、當(dāng)需要對(duì)一行代碼，做小量描述時(shí)，使用以下注釋風(fēng)格
# 這是XXXX給ZZZZ的變量，叫CCCC
$name = '';
 
3、當(dāng)需要對(duì)一行代碼，做簡(jiǎn)介描述時(shí)，使用以下注釋風(fēng)格
$name    = ''; // X表的字段
$index_head = ''; // 首頁(yè)請(qǐng)求頭

10、開放關(guān)閉原則

實(shí)際上這是一個(gè)概念，是設(shè)計(jì)模式中的一種。

簡(jiǎn)單來說，就是一個(gè)已經(jīng)完成上線的class或者api，可以在不改動(dòng)起原文件的情況下，對(duì)其功能進(jìn)行外部擴(kuò)展。

以上這篇基于php編程規(guī)范(詳解)就是小編分享給大家的全部?jī)?nèi)容了，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: