我的php編碼規范

RiverLi 發布于2019-06-27 11:33 / 3593人閱讀

摘要：為什么我們要培養自己的編碼規范我們寫代碼的時候，一個好的編碼規范，對我們來說能夠起到很多意向不到的效果。至少會有一下的好處提高我們的編碼效率。

為什么我們要培養自己的編碼規范？

我們寫代碼的時候，一個好的編碼規范，對我們來說能夠起到很多意向不到的效果。至少會有一下的好處：
1、提高我們的編碼效率。整齊劃一的代碼方便我們進行復制粘貼嘛！
2、提高代碼的可讀性。
3、顯示我們專業。別人看到了我們的代碼，發現整個代碼的書寫流程都整齊劃一，瞬間逼格就上去了！
4、方便團隊協同工作。大家使用同一的規范，這樣就消除了五花八分的書寫方式，同一協調！

編碼規范包含兩大塊，代碼規范和注釋規范

其實我們所寫的php腳本，其實也就是由兩大塊組成的，即對代碼的書寫、對代碼的注釋！不同的框架，甚至不同的公司，對這方面都會有所不同，這里只是已將之言，僅僅是對自己的書寫規范進行一個總結！希望能對其他的朋友以啟示

1、代碼的書寫規范

文件夾的命名：
文件夾同一使用小寫字母。如存放控制器的文件夾，直接命名為controller即可

文件的命名：
如果是類文件的話，那么文件的命名應該同類名稱保持一致，統一使用大駝峰。如Session.class.php , 對應類名稱為Session，
如果是普通的工具腳本，那么統一使用小駝峰，如common.php

類名稱的命名：
類名稱同一使用大駝峰，Cookie類

方法名的命名：
統一使用小駝峰，一般使用 動詞 + 名次 的形式來描述該方法的功能，如sendMessage,發送短信。
在面向對象中，遵循同樣的規則，但是個別地方有所區別：
public getUserName()
protected _getTotalAmount()
private _setBlanceAmount()

變量的命名規范：
關于變量，我們需要多說幾點：
1、無論在面向對象還是非面向對象的語法中，變量統一使用小駝峰，如：$workYears。
但是在面向對象中又有所不同，public 、 protected 、 private ,protected或者private屬性的時候，前面加上了 _ 作為區別

public $startPosition = 1;

protected $_salaryAmount =1000; 

private $_sex = "formale";

2、如果是常量的話，統一使用大寫，中間使用下劃線進行分割。

define("CURRENT_SCRIPT", "index.php");

const TRANSACTION_TYPE = "income";

3、全局變量，使用大駝峰，前綴加上 _ ,所有的單詞首字母大寫。因為知道一個變量的作用域是非常重要的，所以局部變量和全局變量應該很明顯的進行分開！

$_System_Config;

$_Root_Path;

縮進符
關于編碼的縮進符號，我們統一使用制表符縮進！也許有的人會問為什么不適用空格縮進的呢？
原因很簡單，大部分的編輯器都支持制表符等于多少個空格，而使用空格就沒得調了！

運算符號
所有的兩元運算符號，都應該前后使用空格進行
$name = "zero";
$age > 18 ? "adult" : "children";

常見的流程語句規劃
我們約定，所有的流程語句的花括號都多帶帶占據一行。理由：如果遇到較為復雜的業務邏輯，花括號會出現很多的嵌套，這樣一來我們會混淆個個對應的花括號！
1、分支語句

if($age >= 18 && $age <= 30) 
{
    echo "young man";
}
else if($age > 30 && $age <= 60)
{
    echo "middle aged";
}
else
{
    echo "old man";
}

//下面這段代碼高手我們一個問題，在if語句中，即使在可以不要花括號的情況下，花括號也是要寫上的
if($age > 60)
{
    echo "I am very old";
}

switch($status)
{
    case "forbiden"：
        echo "login forbidden";
        break;
       
    case "normal":
        echo "login in";
        break;
        
    default:
        echo "status is wrong" ：
        break;
}

2、循環語句

while($condition)
{
    statesments......;
}

foreach($arrayList as $arrayKey => $arrayItem)
{
    states......;
}

do
{
    statements......;    
}
while($condition)

for($start; condition; changenumber)
{
    statements......;
}

2、注釋的書寫規范

很多人說好的代碼是不需要注釋的，其實，個人認為這是一句很扯淡的話（也可能他是對的，除非整個團隊就他一個人，他包辦了一切，不用看別人的代碼）。

個人的觀點是：多寫注釋，無論是對團隊的其他人，還是對自己都是非常友好的！

根據個人的經驗來看，注釋至少有以下幾個作用：
1、有利于提高代碼的可讀性，畢竟讀你的注釋要比讀你的代碼要容易的多！
2、有利于規劃自己的代碼布局！之所以這么說，是因為和代碼注釋的種類有關。“有利于代碼的布局”，這種看著有點懸的事，光說是說不明白的，我們需要實實在在的例子做支撐！
3、由于我們的注釋規范是按照phpdocumentor的要求，所以通過這個工具，還可以生成一份對代碼的總體說明，相當于一個使用說明書！g

代碼注釋的種類
1、塊注釋
塊注釋，個人認為主要用在了三個地方。對php腳本的描述、對一個大的功能模塊的描述、在一行之內不能寫完注釋的時候，也應該放在塊注釋中

2、行注釋
行注釋，個人認為他是配合塊注釋進行工作的！一般用于描述一個大的功能模塊的具體細節！

實戰的案例
關于phpdocumentor語法的具體使用細節，這里就不多說了，官網上說的再清楚不過了

從上面的例子中我們可以看一下代碼的布局大致是怎么回事，但是還需要我們在實踐中慢慢摸索

GPU云服務器云服務器 php編碼規范規范編碼編碼規范 js安全編碼規范

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/21130.html

看吧，這就是現代化 PHP 該有的樣子

摘要：這大概是我沒有及早使用，或多數開發者流連現狀造成的。它就是，一個的框架。行為驅動開發是來自測試驅動開發的開發過程。簡單的說，它就是經常可能一天幾次將小塊代碼整合進基礎代碼當中的行為。 showImg(https://segmentfault.com/img/remote/1460000013769815); 這是一篇社區協同翻譯的文章，已完成翻譯，更多信息請點擊?協同翻譯介紹?。文章...

Tangpj 2019-06-28 18:33 評論0 收藏0
這就是現代php該有的樣子（二）

摘要：所以，是幫助您創建您的項目的測試框架，單元測試。行為驅動開發是一個來自測試驅動開發的開發過程。這種語言被稱為，是用來描述被測試的預期的行為。代碼將被測試并且沒有異常。這些標準提出了現代編碼風格。本文來自medium----原文鏈接; 歡迎作客我們的php&Laravel學習群：109256050 你需要開始使用測試這是我每天對自己說的話。像很多人一樣，我不會像TDD所建議的那樣測試...

fevin 2019-06-28 18:44 評論0 收藏0
PHP 標準規范中文版發布

摘要：本文經授權轉自社區文檔頁面項目團隊在定制編碼規范，發現原本的已經有點年久失修。并且沒有遵循中文文案排版指北規范在書寫文檔，而我們團隊的文案統一遵循排版指北的標準，猶豫之下就自己的一個，并翻譯了緩存接口還有大部分的消息接口規范。本文經授權轉自 PHPHub 社區 showImg(https://segmentfault.com/img/remote/1460000006780523);...

CloudwiseAPM 2019-07-01 12:15 評論0 收藏0
Travis CI 持續集成服務構建 Composer 類庫簡明教程

摘要：創建帳號提供的是持續集成服務，簡稱。在這里引入的原因是我們的項目需要使用服務進行持續集成和測試，當然你也可以替換成別的單元測試工具。創建單元測試用例是單元測試類庫家族中的一員，使用的一個主要目的是為我們的模塊創建單元測試用例。本文首發于 Travis CI 持續集成服務構建 Composer 類庫簡明教程，轉載請注明出處！在項目開發過程中，編碼工作只是軟件開發整個過程中的一小部分環...

DoINsiSt 2019-07-01 10:06 評論0 收藏0
atom和phpcs

摘要：的編碼規范雖然沒有像那樣集中，有這樣的統一標準見我的這篇文章，但也是有規律可循的。最簡單的莫過于直接使用，但是真的實在太弱了，所以目前業界比較流行的是使用，簡稱。在代碼規范方面，沒有所謂的個人喜好，而只有項目規范。所以目前以及都開始遵循。 php的編碼規范雖然沒有像javascript那樣集中，有eslint這樣的統一標準（見我的這篇文章），但也是有規律可循的。最簡單的莫過于直接使用p...

CntChen 2019-06-27 14:03 評論0 收藏0