아름다운 PHP 코드를 작성하는 방법

좋은 코딩 습관은 일상의 습관을 통해 형성됩니다. 팀이 좋은 코딩 표준을 갖고 모두가 정해진 코딩 표준을 따르면 코드의 품질과 유지 관리성이 더 높아질 것이라고 믿습니다. 현재 PHP는 PSR 표준을 준수해야 합니다. 설명을 위해 코딩에서 일반적으로 사용되는 몇 가지 작성 방법만 나열하겠습니다.

PHP 파일 시작 태그

순수 PHP 코드 파일의 경우 25d582e7aa5f278a148295c8cac7af7b의 종료 태그를 추가하지 마세요. 그 이유는 관심이 있으시면 직접 찾아보실 수 있을 것 같습니다.

<?php

class TestDemo
{
}

클래스 클래스 선언

클래스 이름은 대문자로 시작하는 카멜 케이스(TestDemo)로 지정해야 하며 두 개의 중괄호를 감싸고 동시에 여러 줄의 주석을 사용해야 합니다. 클래스의 생성자와 기능 등을 설명합니다.

/**
 * 这是一个测试Demo类
 * Author: gxcuizy
 * Date: 2021-05-25 13:57:16
 * Class TestClass
 */
class TestDemo
{
}

클래스 클래스의 상수

클래스의 상수 이름은 모두 대문자(HELLO_WORLD)여야 하며, 단어는 밑줄 _로 구분하고, 주석을 하나만 추가하는 것이 가장 좋습니다. // 뒤의 줄 주석은 공백을 두고 주석을 입력합니다.

// 声明一个常量
const HELLO_WORLD = 'best';

클래스 클래스의 멤버 속성

클래스의 멤버 속성(멤버 변수라고도 함) 멤버 속성의 이름 지정은 세 가지 규칙을 따를 수 있습니다. 대문자($UserName)로 시작하는 카멜 케이스, 소문자로 시작하는 카멜 케이스( $userName ), 밑줄 구분($user_name); 세 가지 명명 규칙 모두 허용됩니다. 개인적으로는 자신의 습관에 따라 선택하는 것이 익숙합니다. 동시에 세 가지 명명 규칙 수정자(공개, 보호, 비공개)가 누락될 수 없습니다.

// 声明一个公共变量
public $user_name = '';
// 声明一个静态变量
public static $user_age = 18;

클래스 클래스의 멤버 메소드

클래스의 멤버 메소드 이름 지정에는 소문자로 시작하는 카멜 케이스 명명 규칙(testAction)을 채택해야 합니다. 메소드의 세 가지 수정자(public, protected, private)가 누락될 수 없습니다. , 두 개의 중괄호가 있습니다. 매개변수의 등호 양쪽에 공백이 있어야 합니다. 메소드, 매개변수 설명, 반환 값 설명 등

/**
 * 这是一个测试方法
 * @param string $msg 参数说明
 * @return array
 */
public function testAction($msg = '')
{
    // 返回数据格式
    $return = array('code' => 200, 'msg' => '');
    return $return;
}

/**
 * 这是私有方法，方法命名以单下划线开始
 * @param string $arg 参数说明
 * @return string
 */
private function privateAction($arg = '')
{
    return $arg;
}

연산자 및 표현식

다른 유형의 연산자 또는 표현식과 관련하여 어디에서 사용되든 $a = 1;, 1 + 2 및 1과 같이 기호 양쪽에 공백이 있어야 합니다. && 0 등

/**
 * 获取两个数相加的和
 * @param int $one 第一个数
 * @param int $two 第二个数
 * @return int
 */
public function getUserAge($one = 0, $two = 0)
{
    $sum = $one + $two;
    return $sum;
}

제어 구조를 작성하는 표준 방법

은 if...else, while, switch...case, foreach, for 및 기타 프로세스 제어 구조와 유사합니다. 기본적으로 대괄호() 및와 함께 사용해야 합니다. 중괄호{}, 대괄호()가 양쪽에 공백이 있고, 왼쪽 중괄호(오른쪽 중괄호와 같은 줄에 있어야 함)는 공백이 있고, 닫는 오른쪽 중괄호는 필수입니다. 별도의 줄에 있어야 하며 주요 내용은 중괄호 {} 안에 포함됩니다.

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

빠른 원클릭 서식

이제 많은 IDE에서 PhpStorm 등의 원클릭 코드 서식을 지원합니다. 일반 단축키는 Ctrl + Alt + L입니다. 또한 단축키와 코드를 상황에 맞게 수정할 수도 있습니다. 나만의 습관 포맷 표준, 한 번의 클릭으로 전체 문서의 포맷을 지정할 수도 있고, 코드의 특정 부분만 선택하여 포맷할 수도 있습니다. 추신: 이 파일을 혼자서 만들고 수정하지 않으면 한 번의 클릭으로 쉽게 전체 파일을 포맷하지 마십시오. 다른 사람의 코드도 포맷하는 것이 좋습니다. 모두가 마음에 들지 않습니다. 다른 사람들이 내 코드를 마음대로 망칠 수 있으니 문제를 일으키지 마세요! 문제를 일으키지 마세요! 문제를 일으키지 마세요! 중요한 것은 세 번 말하세요.

최종 요약

먼저 몇 가지 개인적인 제안을 드리겠습니다. 도움이 되길 바랍니다.

• 공백을 추가하지 마십시오. 즉, 필요할 때 공백 하나만 추가하십시오(다음을 따르십시오). 코드 사양)

• 불필요한 줄 바꿈 삭제(코드의 시각적 아름다움에 영향을 줌)

• 댓글뿐만 아니라 디버깅 코드도 제때 삭제해야 한다는 점을 기억하세요(시간이 지나면 잊어버릴까 봐 걱정됩니다)

• 코드 주석, 코드 주석, 코드 주석(아무리 바빠도 적절한 주석을 작성해야 하며 나중에 추가하지 마세요)

• 다른 사람의 코드를 볼 수 있지만 다른 사람의 코드를 수정하지 마십시오. 사람들의 코드 마음대로 (다른 사람들이 당신의 코드를 보면 기분이 좋지 않을 것이기 때문입니다)

Me 일반적으로 사용되는 코드 사양 중 일부를 발췌하여 이야기했습니다. 글에 잘못된 점이 있으면 지적해 주십시오. 시간이 지나면 수정하겠습니다. 감사합니다. 다른 좋은 코딩 기술이 있다면 모든 사람과 공유할 수 있습니다.

추천 학습: php 비디오 튜토리얼

위 내용은 아름다운 PHP 코드를 작성하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!