PHP의 설명적 명명 규칙 연습: 깔끔하고 읽기 쉬운 코드 작성 가이드

설명적인 명명 규칙을 사용하면 코드를 더 쉽게 읽을 수 있고 유지 관리할 수 있으며 자체 문서화할 수 있습니다. 변수, 함수 및 클래스의 목적을 명확하게 전달하는 이름을 사용하면 추가 설명이나 설명 없이도 자신과 다른 사람이 코드를 이해하는 데 도움이 됩니다.

PHP의 실제 지침과 예제를 통해 설명적인 명명 규칙을 채택하는 방법은 다음과 같습니다.

1. 클래스 이름에는 명사를 사용하세요

• 클래스 이름은 자신이 관리하는 엔터티를 나타내야 합니다. 설명이 포함된 클래스 이름은 시스템에서 클래스의 역할을 명확히 합니다.
• 클래스 이름에는 PascalCase를 사용하세요.
• 수업의 목적이나 책임을 반영하는 이름을 사용하세요.

예:

UserAccountManager: 사용자 계정 관리를 담당하는 클래스입니다.
InvoiceGenerator: 송장 생성을 처리하는 클래스입니다.
ShoppingCart: 장바구니 시스템을 나타내는 클래스입니다.

2. 함수 및 메소드 이름에 동사를 사용하세요

• 메서드는 작업을 수행하므로 해당 메서드의 이름을 해당 작업을 설명하는 동사나 동사구로 지정해야 합니다.
• 메서드 및 함수 이름에는 camelCase를 사용하세요.
• 명확성을 위해 get, set, create, update, delete, is, has 등과 같은 동사를 접두사로 사용하세요.

예:

createUser(): 이 함수가 사용자를 생성한다는 것을 분명히 명시합니다.
계산TotalAmount(): 총액을 계산하는 동작을 설명합니다.
isUserLoggedIn(): 사용자의 로그인 여부를 확인하는 메소드입니다.

3. 변수 이름을 구체적으로 지정하세요

• 변수는 무엇을 저장하거나 나타내는지 나타내야 합니다.
• $x, $val, $data와 같이 짧거나 모호한 이름은 피하세요.
• 변수 이름에는 camelCase를 사용하세요.
• 변수의 범위와 의도를 생각해 보세요.

예:

$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 중국어 웹사이트의 기타 관련 기사를 참조하세요!