PHP 스타일 가이드 (Style Guide) - PSR

들어가며

프로그램을 개발하다 보면 이름을 부여해야하는데, 이때 많은 고민을 하게 됩니다.

변수명은 뭘로 할것인지? 함수명은 뭘로 할것인지? 언더바를 포함시켜도 되는지? 등등..

혼자 개발하는 상황보다 대규모로 다수의 개발자와 공동으로 작업할 때는 더 신경쓰이게 되는데요,

때문에 개발자들간에 서로 이해하기 쉽고, 가독성도 높아지도록 권장하는 가이드라인이 있어 소개해드리려고 합니다.

필수가 아닌 권장사항이니 참고해 주세요.

PSR(PHP Standards Recommendations)

PHP-FIG(PHP-FrameWork Interop Group)에서 만든 표준 권고안입니다.

PSR-1과 PSR-2이 스타일 가이드에 대한 부분으로 줄바꿈, 띄워쓰기, 대소문자에 관한 내용을 포함하고 있습니다.

PSR-1 Basic coding standard

PSR-1은 PHP코드들간에, 높은 수준의 기술적 상호 운용성을 보장하기 위해서 필요한 표준 코딩 요소들을 제안하고 있습니다.

주요 내용은 아래와 같습니다.

1. PHP코드는 <?php ?> 태그나 <?= ?> 태그를 이용해야 합니다. 다른 태그를 사용하면 안됩니다.

2. BOM(Byte order Mark)없이 UTF-8 인코딩을 사용해야 합니다.

3. 네임스페이스와 클래스는 오토로딩 표준(PSR-0, PSR-4의 "autoloading")을 따라야 합니다.

4. 클래스 이름은 첫 글자를 대문자로 해야합니다.

5. 클래스 내 상수는 반드시 모두 대문자로 작성하고 구분자로는 _(언더바)를 사용해야 합니다.

6. 클래스 내 메소드의 이름은 카멜케이스(camelCase)방법을 이용해야 합니다.

PSR-2 Coding Style Guid

PSR-1 표준의 연장선인 코딩 스타일에 대한 표준으로서 공통된 스타일을 사용하여 가독성이 좋도록 구체적은 코딩 스타일을 안내하고 있습니다.

주요 내용은 아래와 같습니다.

1. 들여쓰기는 tab대신 4칸의 공백을 사용해야 한다.

2. 닫는 태그(?>)는 사용하지 않는다.

3. namespace 선언뒤에는 한 줄의 공백을 사용하고 여러 개의 use는 줄 공백없이 사용후에 마지막 블록 뒤에 한 줄의 공백을 사용해야 한다.

4. 클래스 구문의 여는 괄호는 다음 줄에 사용하고 닫는 괄호는 본문 다음 줄에 사용할 것

5. 메소드 구문의 여는 괄호는 다음 줄에 사용하고 닫는 괄호는 본문 다음 줄에 사용할 것

6. if 나 elseif 같은 제어 관련 구문은 제어문 뒤에 한 개의 공백을 두고 그 후에 괄호를 사용하고 조건문을 기술해야 한다.

   함수 호출이나 메소드 호출은 메소드명 뒤에 공백이 있으면 안된다.

7. 줄 길이는 80자를 넘지 않는 것을 권장한다.

8. true, false, null은 반드시 소문자여야 한다.

이외에도 PSR의 다른 규약들도 확인하고 싶으시다면 아래 링크를 참조해주세요.

https://www.lesstif.com/pages/viewpage.action?pageId=24445325#PHP%ED%91%9C%EC%A4%80%EA%B6%8C%EA%B3%A0(PSR)-PSR-2CodingStyleGuide

참고.

https://www.php-fig.org/