搜尋

首頁 >後端開發 >PHP問題 >如何寫出漂亮的PHP程式碼

如何寫出漂亮的PHP程式碼

醉折花枝作酒筹
醉折花枝作酒筹轉載
2021-07-06 15:33:451909瀏覽

一個好的編碼習慣靠平時的習慣養成，團隊裡有好的編碼規範，並且每個人都按照制定的編碼規範來執行，那麼我相信代碼的質量以及可維護性會上升一個檔次。而目前PHP要求都要遵守PSR標準規範，我只列舉一部分編碼中常用的寫法來說明，更多的規範大家可以搜尋PSR標準。

如何寫出漂亮的PHP程式碼

PHP檔案開始標籤

對於純PHP的程式碼文件，必須以9c0edb6eeef7ea69c8ee6bd73a1dfebd的結束標籤，至於為啥，有興趣的自己去了解哈。 

<?php

class TestDemo
{
}

Class類別的宣告

類別名稱必須以大寫開頭的駝峰式命名(TestDemo)，兩個花括號換行且獨佔一行，同時需要用多行註解說明類別的創建人以及作用等。 

/**
 * 这是一个测试Demo类
 * Author: gxcuizy
 * Date: 2021-05-25 13:57:16
 * Class TestClass
 */
class TestDemo
{
}

Class類別的常數

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

// 声明一个常量
const HELLO_WORLD = &#39;best&#39;;

Class類別的成員屬性

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

// 声明一个公共变量
public $user_name = &#39;&#39;;
// 声明一个静态变量
public static $user_age = 18;

Class類別的成員方法

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

/**
 * 这是一个测试方法
 * @param string $msg 参数说明
 * @return array
 */
public function testAction($msg = &#39;&#39;)
{
    // 返回数据格式
    $return = array(&#39;code&#39; => 200, &#39;msg&#39; => &#39;&#39;);
    return $return;
}

/**
 * 这是私有方法，方法命名以单下划线开始
 * @param string $arg 参数说明
 * @return string
 */
private function privateAction($arg = &#39;&#39;)
{
    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;
}

控制結構的規範寫法

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

/**
 * 判断用户是否成年
 * @param int $age 年龄
 */
public function logicAction($age = 18)
{
    if ($age >= 18) {
        echo &#39;已成年&#39;;
    } else {
        echo &#39;未成年&#39;;
    }
}

快速一鍵格式化

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

最後總結

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

  • 別加多餘的空格，也就是該加一個空格就加一個就行（依照程式碼規格就行）

  • 多餘的換行刪除掉（影響程式碼視覺美觀）

#調試程式碼記得及時刪除，而不僅僅是註釋（怕你久而久之就忘了）

###程式碼註釋，程式碼註釋，程式碼註釋（再忙也要適當的寫註釋，不要說後面再加）############你可以看不爽別人的程式碼，但不要隨意修改別人的程式碼（因為別人看你的程式碼也不爽）######## #####我只是抽取了一小部分常用到的程式碼規格說一下，如果有寫的不對的地方請大家指出，我會及時修改，謝謝。如果你還有其他好的程式設計技巧，也歡迎和大家一起分享。 ######推薦學習：###php影片教學######

以上是如何寫出漂亮的PHP程式碼的詳細內容。更多資訊請關注PHP中文網其他相關文章！

php phpstorm 常量 运算符 if switch for while foreach 成员变量 class public private protected ide 代码规范
陳述：
本文轉載於：segmentfault.com。如有侵權，請聯絡admin@php.cn刪除
上一篇：聊聊php中的事件溯源下一篇：聊聊php中的事件溯源

相關文章

看更多