萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP 類別宣告規範與程式碼佈局最佳實踐

類別宣告格式規範

<?php
// 正確格式
class Sample extends BaseClass implements SomeInterface {
    // 常數
    public const STATUS_ACTIVE = 1;

    // 屬性:依可見性分組,public → protected → private
    public int $publicProp = 0;
    protected string $protectedProp = '';
    private array $privateProp = [];

    // 建構子
    public function __construct(int $i, int $j) {
        $this->publicProp = $i;
        $this->protectedProp = (string)$j;
    }

    // 空方法:大括號同行
    public function emptyMethod() {}

    // 一般方法:左大括號同行末尾,右大括號獨立一行對齊宣告
    public function doSomething(string $param): void {
        // 方法主體
    }
}
?>

關鍵格式規則

規則正確錯誤
方法名與參數列表間無空格function foo()function foo ()
左大括號 { 置於宣告同行末尾class Foo {class Foo
{
右大括號 } 獨立一行,與宣告對齊}\n} } 或不對齊
空方法大括號同行function foo() {}function foo() {\n}
方法間以單一空行分隔一空行無空行或多空行
屬性依可見性分組排序public → protected → private混雜無序

程式碼佈局:區域變數宣告位置

  • 僅在區塊開頭宣告變數:任何被 {} 包裹的區塊(方法、if、for、foreach 等)。
  • 不要在首次使用時才宣告(舊式 C 風格),這會分散注意力、降低可移植性。
  • 例外:for 迴圈索引變數可在初始化子句宣告:for (int $i = 0; $i < $max; $i++)。
<?php
function myMethod(): void {
    $int1 = 0;  // 方法區塊開頭宣告

    if ($condition) {
        $int2 = 0;  // if 區塊開頭宣告
        // ...
    }

    // 避免:在區塊中間宣告
    // doSomething();
    // $lateVar = 1; // 不佳
}
?>

避免變數遮蔽

內層區塊勿宣告與外層同名變數,導致遮蔽:

<?php
$count = 10;  // 外層
function myMethod() {
    if ($condition) {
        $count = 0;  // 遮蔽外層 $count,易造成誤解
        // ...
    }
}
?>

改用具體名稱:$innerCount、$loopCount 等。

現代 PHP 類別進階結構 (PHP 8+)

<?php
readonly class DataTransferObject {
    public function __construct(
        public int $id,
        public string $name,
        public DateTimeImmutable $createdAt,
    ) {}
}

// Enum 替代常數類別
enum OrderStatus: int {
    case PENDING = 0;
    case PAID = 1;
    case SHIPPED = 2;
    case COMPLETED = 3;
    case CANCELLED = -1;
}
?>

工具自動化格式化

  • PHP-CS-Fixer:php-cs-fixer fix src --rules=@PSR12
  • PHP_CodeSniffer:phpcs --standard=PSR12 src
  • IDE 整合:PhpStorm / VS Code 存檔自動格式化。

統一的類別宣告與佈局風格,能降低認知負擔、減少合併衝突、提升程式碼專業度。

copyright © 萬盛學電腦網 all rights reserved