PHP編碼規範



每個公司都根據其最佳實踐遵循其自身的編碼規範。需要編碼規範是因為可能有許多開發人員在不同的模組上工作,如果他們開始制定自己的規範,那麼原始碼將變得非常難以管理,並且將來難以維護該原始碼。

以下是一些應該使用編碼規範的原因:

  • 您的同行程式設計師必須理解您編寫的程式碼。編碼規範充當所有團隊破譯程式碼的藍圖。

  • 一致的編碼實現的簡潔性和清晰性可以避免常見的錯誤。

  • 如果您過段時間修改程式碼,那麼理解該程式碼就很容易了。

  • 遵循統一的編碼規範可以提高軟體質量。

在PHP中編碼時,可以遵循一些指導原則。

縮排和行長

使用4個空格縮排,不要使用製表符,因為不同的計算機使用不同的製表符設定。建議將行長保持在約75-85個字元,以提高程式碼的可讀性。

控制結構

這些包括if、for、while、switch等。控制語句在控制關鍵字和左括號之間應留一個空格,以將其與函式呼叫區分開來。強烈建議始終使用花括號,即使在技術上可選的情況下也是如此。

示例

if ((condition1) || (condition2)) {
   action1;
} elseif ((condition3) && (condition4)) {
   action2;
} else {
   default action;
}

您可以按如下方式編寫switch語句

switch (condition) {
   case 1:
      action1;
      break;

   case 2:
      action2;
      break;

   default:
      defaultaction;
      break;
}

函式呼叫

函式呼叫時,函式名、左括號和第一個引數之間不應有空格;逗號和每個引數之間應有空格;最後一個引數、右括號和分號之間不應有空格。示例如下:

$var = foo($bar, $baz, $quux);

函式定義

函式宣告遵循“BSD/Allman風格”:

function fooFunction($arg1, $arg2 = '') {
   if (condition) {
      statement;
   }
   return $val;
}

註釋

C風格註釋(/* */)和標準C++註釋(//)都可以。允許使用Perl/shell風格註釋(#),但不鼓勵使用。

PHP程式碼標籤

始終使用<?php ?>來分隔PHP程式碼,而不是<? ?>簡寫。這是PHP相容性所必需的,也是在不同作業系統和設定上包含PHP程式碼最可移植的方式。

變數名

  • 使用全部小寫字母

  • 使用'_'作為單詞分隔符。

  • 全域性變數應以'g'開頭。

  • 全域性常量應全部大寫,並用'_'分隔。

  • 靜態變數可以以's'開頭。

使函式可重入

函式不應保留阻止函式可重入的靜態變數。

宣告塊的對齊

宣告塊應對齊。

每行一個語句

除非語句非常密切相關,否則每行應只有一個語句。

短方法或函式

方法應限制在一頁程式碼內。

編寫PHP程式時,可能還需要考慮許多其他方面。總的意圖應該是在整個程式碼程式設計過程中保持一致,只有遵循任何編碼規範才有可能。如果您喜歡不同的東西,您可以設計您自己的規範。

廣告