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

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

成都一家集口碑和實力的網(wǎng)站建設(shè)服務(wù)商,擁有專業(yè)的企業(yè)建站團隊和靠譜的建站技術(shù),10多年企業(yè)及個人網(wǎng)站建設(shè)經(jīng)驗 ,為成都上千余家客戶提供網(wǎng)頁設(shè)計制作,網(wǎng)站開發(fā),企業(yè)網(wǎng)站制作建設(shè)等服務(wù),包括成都營銷型網(wǎng)站建設(shè),成都品牌網(wǎng)站建設(shè),同時也為不同行業(yè)的客戶提供網(wǎng)站制作、網(wǎng)站設(shè)計的服務(wù),包括成都電商型網(wǎng)站制作建設(shè),裝修行業(yè)網(wǎng)站制作建設(shè),傳統(tǒng)機械行業(yè)網(wǎng)站建設(shè),傳統(tǒng)農(nóng)業(yè)行業(yè)網(wǎng)站制作建設(shè)。在成都做網(wǎng)站,選網(wǎng)站制作建設(shè)服務(wù)商就選創(chuàng)新互聯(lián)公司。

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

PHP文件開始標(biāo)簽

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

<?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ī)則都可以,我個人習(xí)慣用下劃線分隔式,大家也可以根據(jù)自己的習(xí)慣選擇,但是最好與團隊編碼規(guī)則保持一致即可,同時三個修飾符(public、protected、private)不能少。

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

Class類的成員方法

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

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

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

運算符和表達式

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

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

控制結(jié)構(gòu)的規(guī)范寫法

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

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

快速一鍵格式化

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

最后總結(jié)

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

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

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

  • 調(diào)試代碼記得及時刪除,而不僅僅是注釋(怕你久而久之就忘了)

  • 代碼注釋,代碼注釋,代碼注釋(再忙也要適當(dāng)?shù)膶懽⑨專灰f后面再加)

  • 你可以看不爽別人的代碼,但是不要隨意修改別人的代碼(因為別人看你的代碼也不爽)

到此,相信大家對“如何規(guī)范地寫PHP代碼”有了更深的了解,不妨來實際操作一番吧!這里是創(chuàng)新互聯(lián)網(wǎng)站,更多相關(guān)內(nèi)容可以進入相關(guān)頻道進行查詢,關(guān)注我們,繼續(xù)學(xué)習(xí)!

當(dāng)前題目:如何規(guī)范地寫PHP代碼
鏈接分享:http://bm7419.com/article16/iihidg.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供網(wǎng)站導(dǎo)航網(wǎng)站建設(shè)、網(wǎng)站策劃建站公司、ChatGPT網(wǎng)頁設(shè)計公司

廣告

聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時需注明來源: 創(chuàng)新互聯(lián)

外貿(mào)網(wǎng)站制作