PSR-PHP 中的基本編碼標準

有沒有想過為什麼有些 PHP 程式碼庫使用起來很愉快，而有些則感覺像迷宮？這很大程度上取決於遵循一致的編碼標準。讓我們來探索 PSR-1，它是現代 PHP 開發的基礎，可幫助團隊編寫更清晰、更易於維護的程式碼！

PSR-1 規則概述

1. 文件和命名空間

• 檔案必須只使用
• PHP 程式碼檔案必須只使用 UTF-8，不含 BOM
• 檔案應該聲明符號（類別、函數、常數）或引起副作用（產生輸出、修改設定等），但不應該兩者都做

2.命名空間和類別名

• 類別必須在 StudlyCaps 中聲明
• 類別常數必須全部大寫並帶有底線分隔符號

3. 類別方法

• 方法名稱必須以駝峰命名法聲明

實際實施

讓我們看看範例儲存庫中正確的 PSR-1 實作：

<?php

namespace JonesRussell\PhpFigGuide\PSR1;

class UserManager
{
    const VERSION = '1.0.0';
    const ERROR_TYPE_NOT_FOUND = 'not_found';

    public function getUserById($id)
    {
        // Implementation
        return ['id' => $id, 'name' => 'John Doe'];
    }
}

此範例示範：

• 使用 StudlyCaps 進行正確的命名空間聲明
• StudlyCaps 中的類別名
• 大寫帶下劃線的常數
• 方法名稱採用駝峰命名法

常見違規行為和修復

1. 混合職責

2. 命名不正確

與現代 PHP 工具集成

我們的範例儲存庫包含以下設定：

• 用於 PSR-1 驗證的 PHP_CodeSniffer（作曲家檢查風格）
• 自動風格修復（作曲家修復風格）
• 用於測試實作的 PHPUnit
• Composer 自動載入遵循 PSR-4

下一步

在下一篇文章中，我們將探討 PSR-12，它透過更全面的樣式指南擴展了這些基本編碼標準。這篇文章是我們的 PHP PSR 標準系列的一部分。

資源

• 官方 PSR-1 規範
• PHP_CodeSniffer PSR-1 規則集
• 系列範例儲存庫（v0.1.0 - PSR-1 實作）

以上是PSR-PHP 中的基本編碼標準的詳細內容。更多資訊請關注PHP中文網其他相關文章！