PHP での記述的な命名規則の実践: クリーンで読みやすいコードを書くためのガイド

記述的な命名規則は、コードをより読みやすく、保守しやすく、自己文書化するのに役立ちます。変数、関数、クラスの目的を明確に伝える名前を使用すると、余分なコメントや説明を必要とせずに、自分自身と他の人がコードを理解するのに役立ちます。

PHP で実践的なガイドラインと例を使用して、わかりやすい命名規則を採用する方法を次に示します。

1. クラス名に名詞を使用する

• クラス名は、管理するエンティティを表す必要があります。わかりやすいクラス名により、システム内でのクラスの役割が明確になります。
• クラス名には PascalCase を使用します。
• クラスのオブジェクトまたは責任を反映した名前を使用します。

例:

UserAccountManager: ユーザー アカウントの管理を担当するクラス。
InvoiceGenerator: 請求書の生成を処理するクラス。
ShoppingCart: ショッピング カート システムを表すクラス。

2. 関数名とメソッド名に動詞を使用する

• メソッドはアクションを実行するため、メソッドの名前には、その動作を説明する動詞または動詞句を付ける必要があります。
• メソッド名と関数名にはキャメルケースを使用します。
• わかりやすくするために、get、set、create、update、delete、is、has などの動詞を接頭辞として付けます。

例:

createUser(): この関数がユーザーを作成することを明確に示します。
CalculateTotalAmount(): 合計金額を計算するアクションを記述します。
isUserLoggedIn(): ユーザーがログインしているかどうかを確認するメソッド。

3. 変数名は具体的にする

• 変数は、何を保存するか、何を表すかを示す必要があります。
• $x、$val、$data などの短い名前や曖昧な名前は避けてください。
• 変数名にはキャメルケースを使用します。
• 変数のスコープと意図について考えてください。

例:

$totalOrderAmount: 注文の合計金額を保存します。
$userEmailAddress: ユーザーの電子メール アドレスを保持していることを明確に示します。
$invoiceItems: 一般的な $items だけでなく、請求書の項目を表します。

4. 過度に一般的な名前を避ける

• そのコンテキストで特に意味がない限り、$data、$info、$result などの名前は避けてください。
• 必要に応じて、$userData、$productInfo、$searchResult などの特定のコンテキストを提供します。

5. ブール変数は質問をする必要がある

• 変数がブール値の場合、その名前は正誤質問を反映する必要があります。
• ブール値であることを明確にするために、is、has、 should、can を接頭辞として使用します。

例:

$isActive: 何かがアクティブかどうかを確認するためのブール値であることを明確に示唆しています。
$hasAccess: ユーザーがリソースにアクセスできるかどうかを確認します。
$canEdit: 現在のユーザーがアイテムを編集できるかどうかを示します。

6. 定数は説明的かつ具体的でなければなりません

• 定数は不変の値を反映し、UPPERCASE_SNAKE_CASE で記述する必要があります。
• DEFAULT_VALUE のような一般的な名前は避け、よりわかりやすい名前を使用してください。

例:

MAX_LOGIN_ATTEMPTS: 許可されるログイン試行の最大数を明確に説明します。
DEFAULT_CURRENCY_CODE: トランザクションで使用される通貨コードを記述します。
ERROR_CODE_INVALID_EMAIL: 電子メール検証の失敗に関連する説明的なエラー コード。

7. コレクションの命名

• 変数がコレクション (項目の配列など) を表す場合は、複数の名詞を使用するか、単語リストを追加して明確にしてください。

例:

$userList: ユーザーのコレクション。
$products: 製品オブジェクトのコレクション。
$orderItems: 注文内のアイテムの配列。

実践例

class ShoppingCart {
    private $cartItems = [];
    private $totalCartValue = 0;

    public function addItemToCart($productId, $quantity) {
        $itemPrice = $this->getProductPriceById($productId);
        $this->cartItems[] = [
            'productId' => $productId,
            'quantity' => $quantity,
            'price' => $itemPrice

以上がPHP での記述的な命名規則の実践: クリーンで読みやすいコードを書くためのガイドの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。