如何規(guī)范地寫PHP代碼

本篇內容主要講解“如何規(guī)范地寫PHP代碼”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學習“如何規(guī)范地寫PHP代碼”吧!

一個好的編碼習慣靠平時的習慣養(yǎng)成，團隊里有好的編碼規(guī)范，并且每個人都按照制定的編碼規(guī)范來執(zhí)行，那么我相信代碼的質量以及可維護性會上升一個檔次。而目前PHP要求都要遵守PSR標準規(guī)范，我只列舉一部分編碼中常用的寫法進行說明，更多的規(guī)范大家可以搜索PSR標準。

PHP文件開始標簽

對于純PHP的代碼文件，必須以<?php 或者<?標簽開始，并且獨占一行，同時不要加?>的結束標簽，至于為啥，感興趣的自己去了解哈。

<?php

class TestDemo
{
}

Class類的聲明

類名必須以大寫開頭的駝峰式命名(TestDemo)，兩個花括號換行且獨占一行，同時需要用多行注釋說明類的創(chuàng)建人以及作用等。

/**
 * 這是一個測試Demo類
 * Author: gxcuizy
 * Date: 2021-05-25 13:57:16
 * Class TestClass
 */
class TestDemo
{
}

Class類的常量

類中的常量命名必須全部字母都要大寫(HELLO_WORLD)，同時單詞間以下劃線_分隔，而且最好增加注釋說明，單行注釋最好在//后先加一個空格再接注釋說明。

// 聲明一個常量
const HELLO_WORLD = 'best';

Class類的成員屬性

類中的成員屬性（也叫成員變量），成員屬性的命名可以遵循三個規(guī)則：大寫開頭的駝峰式($UserName)、小寫開頭的駝峰式($userName)、下劃線分隔式($user_name)；這三種命名規(guī)則都可以，我個人習慣用下劃線分隔式，大家也可以根據自己的習慣選擇，但是最好與團隊編碼規(guī)則保持一致即可，同時三個修飾符（public、protected、private）不能少。

// 聲明一個公共變量
public $user_name = '';
// 聲明一個靜態(tài)變量
public static $user_age = 18;

Class類的成員方法

類中的成員方法的命名必須采用小寫開頭的駝峰式命名(testAction)規(guī)則，方法的三個修飾符（public、protected、private）不能少，兩個花括號換行且獨占一行，參數的等號兩邊各一個空格，方法的注釋不要漏了哈，包括方法的作用、參數說明以及返回值說明等。

/**
 * 這是一個測試方法
 * @param string $msg 參數說明
 * @return array
 */
public function testAction($msg = '')
{
    // 返回數據格式
    $return = array('code' => 200, 'msg' => '');
    return $return;
}

/**
 * 這是私有方法，方法命名以單下劃線開始
 * @param string $arg 參數說明
 * @return string
 */
private function privateAction($arg = '')
{
    return $arg;
}

運算符和表達式

相對于運算符或者不同類型的表達式，不管在任何地方使用，我們都需要在其符號兩邊有一個空格，例如$a = 1;、1 + 2以及1 && 0等。

/**
 * 獲取兩個數相加的和
 * @param int $one 第一個數
 * @param int $two 第二個數
 * @return int
 */
public function getUserAge($one = 0, $two = 0)
{
    $sum = $one + $two;
    return $sum;
}

控制結構的規(guī)范寫法

類似if …… else、while、switch ……case、foreach、for等流程控制結構，基本都需要與括號()和花括號{}配合使用，要求括號()兩邊均有一個空格，而左花括號{需要與右括號)同行且有一個空格，而作為結束的右花括號}則需要單獨一行，而主體內容都是包含在花括號{}中。

/**
 * 判斷用戶是否成年
 * @param int $age 年齡
 */
public function logicAction($age = 18)
{
    if ($age >= 18) {
        echo '已成年';
    } else {
        echo '未成年';
    }
}

快速一鍵格式化

現在很多IDE都支持一鍵格式化代碼，比如PhpStorm等，一般快捷鍵都是Ctrl + Alt + L，你也可以根據你自己的習慣進行修改快捷鍵以及代碼格式的標準，既可以一鍵格式化整個文檔，也可以只選中某一部分代碼進行格式化。PS：如果這個文件不是你一個人創(chuàng)建和修改，請不要輕易一鍵格式化整個文件，因為會把人家的代碼也給格式化了，推薦只格式化你自己的代碼即可，每個人都不喜歡別人隨意動自己的代碼，所以不要搞事情！不要搞事情！不要搞事情！重要的事情說三遍，你懂的。

最后總結

先給出個人的幾點建議吧，希望對你有所幫助：

• 別加多余的空格，也就是該加一個空格就加一個就行（按照代碼規(guī)范來就行）

• 多余的換行刪除掉（影響代碼視覺美觀）

• 調試代碼記得及時刪除，而不僅僅是注釋（怕你久而久之就忘了）

• 代碼注釋，代碼注釋，代碼注釋（再忙也要適當的寫注釋，不要說后面再加）

• 你可以看不爽別人的代碼，但是不要隨意修改別人的代碼（因為別人看你的代碼也不爽）

到此，相信大家對“如何規(guī)范地寫PHP代碼”有了更深的了解，不妨來實際操作一番吧！這里是億速云網站，更多相關內容可以進入相關頻道進行查詢，關注我們，繼續(xù)學習！