WordPress에 대한 코딩 표준 [안내]

우리가 (WordPress뿐만 아니라) 코딩 표준을 가지고있는 이유는 프로그래머를위한 친숙한 환경 만들기 프로젝트 작업. WordPress는 특히 다양한 제품을 포함합니다. 핵심 자체부터 테마 및 플러그인에 이르기까지 살펴볼 내용이 많이 있습니다..

모든 사람들이 동일한 방식으로 코드를 형식화하고 주석, 동일한 스타일의 문서 등을 사용하면 함께 작업하는 것이 훨씬 쉬워지고 새 프로젝트에 참여하는 학습 곡선이 가파르게되지는 않습니다.

WordPress의 응집력에 대한 필요성은 코드베이스가있는 국가에 의해 확대됩니다. WordPress는 엄격한 객체 지향 접근 방식을 따르지 않으며 MVC 패턴을 사용하지 않습니다. 예외없이 OOP 및 MVC 가이드 라인을 따르는 프로젝트 (예 : Laravel)에는 일관성 및 모범 사례가 있습니다. “구운” 구조 때문에.

WordPress는 아쉽게도 스파게티 코딩에 익숙합니다. 너 뭐든지하고 싶어.. 베스트 프랙티스는 단순히 나쁜 코드를 사용하는 제품이 (표면에서) 잘 작동하기 때문에 시행하기가 어렵습니다..

WordPress 코딩 표준을 따르면 WordPress의 코딩 정신에 대해 조금 배우고 더 많은 WordPress 호환 제품을 만들 수 있습니다. 당신이 걱정하는 커뮤니티를 보여주고 고품질의 코드를 고집합니다..

Hongkiat.com에 대한 추가 정보 :

10 웹 개발자를위한 최악의 악몽
CSS가 왜 가장 힘든 언어가 될 수있는 5 가지 이유
30 가지 공통적 인 반응 프로그래머들은 일이 잘못 될 때가 있습니다.

표준에 관한 몇 가지주의 사항

표준은 옳고 그름을 정의하지 않습니다.. 규칙에 동의하지 않을 수 있습니다. 예를 들어, 필요하지 않더라도 중괄호를 항상 사용해야합니다. WordPress 코딩 표준의 목적은 옳고 그른지를 결정하는 것이 아니라 WordPress에서 어떻게해야하는지 결정하는 것입니다..

표준은 논쟁의 여지가 없다.. 표준을 사용하는 것은 당신이 좋아하지 않는 들여 쓰기 스타일에 대항 할 수있는 장소가 아닙니다. 코딩 표준에 뭔가가 있다면 그렇게하십시오. WordPress 개발자가 당신을 사랑합니다! 즉, 당신이 거기에있는 어떤 것에 동의하지 않는다면 당신의 목소리를 높이고 사람들에게 알리십시오. 일을 더 잘 할 수는 있지만 표준에서 허용하는 경우 코딩 스타일 만 변경해야합니다..

항문 보유력에 대한 일관성. 프로젝트의 마지막 10 %에서 클래스에 대한 잘못된 명명 규칙을 사용하고 있음을 발견 한 경우 중간 단계로 전환하지 마십시오. 개인적인 견해로는 때로는 때로는 정확하지 않고 때로는 올바르지 않은 것을 일관되게 잘못 읽고 싶습니다. 언제든지 한 번에 작업을 변경하거나 끝에 코드를 읽는 스크립트를 작성할 수 있습니다..

다음 표준은 어렵다.! 이전에 입력을 했더라도, 아래 줄 대신 함수와 같은 줄에 중괄호를 배치하는 것은 매우 쉽습니다. 그러나 약 100 개의 작은 규칙을 생각할 때 전체 프로세스가 약간 오류가 발생하기 쉽습니다. 다음과 같은 표준에 대한 엄격한 태도에도 불구하고 나는 실수로 다른 사람만큼 유죄입니다. 하루가 끝날 때 부정확 한 들여 쓰기는 취소 할 수없는 죄가 아닙니다. 모든 규칙을 따르기 위해 최선을 다해 시간 안에 모든 것을 배우게됩니다..

워드 프레스 코딩 표준

현재 WordPress에는 PHP, HTML, Javascript 및 CSS와 같은 주요 언어별로 4 개의 안내서가 있습니다. 그것들은 더 큰 지식의 일부인 핵심 기여자 핸드북 (Core Contributor Handbook)의 일부를 형성합니다. 모든 것을 진행하는 데는 시간이 걸릴 수 있으므로 사람들이 잘못 이해하는 것을 자주 겪고있는 네 가지 언어 중 일부 발췌 문장을 강조했습니다..

PHP

PHP는 WordPress의 주요 언어이며 규정에 익숙한 상당히 느슨한 형식의 언어입니다.

가새 스타일

시작 중괄호는 항상 줄 끝 부분에 있어야합니다. 관련 명령문은 이전 닫는 중괄호와 동일한 줄에 있어야합니다. 이는 코드 예제를 통해 가장 잘 설명됩니다.

if (조건) // Do Something elseif (조건) // Do Something else // Do Something

관대 한 공간 사용법

나는 (나는 시력이 나쁘다) 코드를 부숴 먹은 팬이 아니기 때문에 이것이 특히 시행하기를 좋아한다. 공백 넣기 쉼표, 그리고 양쪽에 논리적 인, 비교, 끈 과 할당 연산자, 후 만약, elseif, ...에 대한, 각각 과 스위치 진술 등.

공간을 추가해서는 안되는 곳을 말하는 것이 더 쉽습니다! 공백을 추가하면 안되는 유일한 시간은 형변환 또는 배열 참조.

예외에 대한 다소 혼란스러운 예외는 배열입니다. 배열 키는 변수입니다., 이 경우에는 공백을 사용하십시오. 이 예제는이 사실을 분명히해야한다.

function my_function ($ complete_array = null, $ key_1 = 4, $ key_2 = 'bar') if (null == $ complete_array) $ final_array = $ complete_array;  else $ key_1 = (정수) $ key_1; $ final_array [0] = 'this'; $ final_array [$ key_1] = 'is'; $ final_array [$ key_2] = 'an'; $ final_array [ 'last'] = '예';  return $ final_array;

명명 규칙

이 기능은 익숙해지기가 어려울 수 있습니다. 특히 다른 환경에서 온 경우에는 더욱 그렇습니다. 요컨대 :

변수 이름 해야한다 모두 소문자, 밑줄로 분리 된 단어
클래스 이름 사용해야한다 대문자로 된 단어 밑줄로 구분 된. 약어 모두가되어야한다. 대문자
상수 해야한다 모두 대문자, 밑줄로 표시
파일 이름 해야한다 모두 소문자, 대시로 구분 된

요다 조건

당신이 사용했던 것보다 다른 방법으로 조건을 작성하면 구문 분석 오류를 방지 할 수 있습니다. 좀 이상하게 보이지만 코드가 더 좋습니다..

if ( 'Daniel'=== $ name) echo '당신이 기사를 쓰자.';

HTML

HTML에는 이와 관련된 규칙이 많지 않으므로 모듈화를 위해 많은 것을 생각해 낼 수 있습니다. HTML을 작성할 때 알아야 할 5 가지 규칙 만 있습니다.

코드가 W3C 유효성 검사기에 대해 유효성을 검사해야합니다..
자동 마감 HTML 태그는 슬래시 앞에 정확히 하나의 공백이 있어야합니다 (개인적으로 싫어하지만 WordPress 애완 동물과 같은 W3C 사양입니다)
속성 및 태그는 모두 소문자 여야합니다. 유일한 예외는 속성 값이 사람의 소비를 의미하는 경우이며,이 경우 속성 값은 자연스럽게 입력되어야합니다.
모든 속성은 값을 가져야하며 따옴표로 묶어야합니다 ( 올바르지 않습니다.)
탭을 사용하여 들여 쓰기를 수행해야하며 논리 구조를 따라야합니다..

CSS

CSS는 느슨하게 입력 된 다른 언어이기 때문에 여기서도 수행해야 할 많은 작업이 있습니다. 그렇더라도, 표준은 코더에서 꽤 쉽게됩니다..

셀렉터

선택자는 필요에 따라 자격을 갖추어야하고, 사람이 읽을 수 있어야하며, 단어가 대시로 구분되어 소문자이어야하며, 속성 선택자는 큰 따옴표를 사용해야합니다. 다음은 간략한 예입니다.

입력 [type = "text"], 입력 [type = "password"], .name-field background : # f1f1f1;

부동산 주문

표준은 CSS 규칙에 대한 특정 순서를 지정하지 않기 때문에 여기에 개인 공간의 필요성을 인식합니다. 그들 해야 할 것 당신이 의미 구조를 따라야한다고 말하자. 말이된다. 관계별로 속성을 그룹화하거나 사전 순으로 그룹화하십시오., 무작위로 쓰지 마라..

임의성의 가장 큰 원인은 “오 나는 또한 여백을 추가해야합니다.” 그런 다음 하단에 추가합니다. 여분의 .3 초를 가져 와서 논리적 인 장소에 규칙을 추가하십시오..

디스플레이
포지셔닝
박스 모델
색상 및 타이포그래피
다른

.프로필 - 모달 디스플레이 : 블록; 위치 : 절대; 왼쪽 : 100px; 상단 : 90px; 배경 : # ff9900; color : #fff;

값 서식 지정

이것은 제가 특히 불일치를 보는 것을 싫어하는 곳입니다. 지침을 따르지 않는다면 가끔은 값 앞에 공백이있는 것보다 더 좋습니다. 간혹 속기를 사용하기도하고 때로는 사용하지 않는 것도 있습니다. 때로는 0 값에 단위를 사용하는 경우가 있습니다..

값 서식은 꽤 복잡하지만 그것은 약간 연습으로 자연적으로 온다. 값을 포맷팅하기위한 CODEX의 정확한 가이드를 살펴보십시오..

자바 스크립트

제 경험상 Javascript는 모든 곳을 다니는 경향이 가장 큽니다. 많은 개발자들이 상당한 양의 자바 스크립트를 알고 있지만 HTML, CSS 및 PHP에 대한 뒷모습으로 점차적으로 배웠습니다. 새로운 언어로 시작하면 더 많은 실수를 저지르고 그 실수가 치명적인 오류를 일으키지 않으면 그 언어는 당신 안에 뿌리 내릴 수 있습니다.

대부분의 경우 표준은 회선 제한 또는 상태를 나타냅니다. “한 줄이 너무 길지 않은 경우”. 이것은 jQuery 스타일 가이드를 참조합니다. 행의 100 자 제한. WordPress 가이드는 jQuery 가이드를 기반으로하므로 잘 읽는 것이 좋습니다..

세미콜론

이것은 가장 간단한 규칙이지만 자주 간과되는 것입니다. 코드가 없어도 작동하기 때문에 세미콜론을 생략하지 마십시오. 그냥 엉망이야..

들여 쓰기

들여 쓰기에는 항상 탭을 사용해야합니다. 전체 파일의 내용이 하나라도 포함되어 있더라도 클로저의 내용을 들여 쓰기해야합니다. 왜 표준을 읽지 않고서도 언더 인 드 톱 레벨 폐쇄가 나를 괴롭혔는지 잘 모르겠습니다..

끊는 선

긴 문자열을 끊을 때는 항상 연산자 뒤에 줄을 긋습니다., 변수를 매달려 두지 마라.. 언뜻 보면 줄이 끊어지고 세미콜론을 잊어 버리지 않은 것입니다..

또한 조건이 길면 여러 줄로 나눠서 앞에 탭을 추가하십시오. 이 하나가 내 눈에 이상하게 보입니다. 그러나 조건과 신체 사이에 추가되는 분리는 매우 눈에니다..

if (firstCondition () && secondCondition () && thirdCondition ()) var html = '이 행은'+ n + '단어로 구성되어 있으므로'+ '연산자';

jQuery 반복

표준 jQuery 반복에 따르면 (jQuery.each ()) jQuery 객체에만 사용해야합니다. 기본을 사용해야합니다. ...에 대한, for / in, 동안 다른 컬렉션을 반복하기위한 Javascript의 루프.

결론

메모하고 추적해야 할 것이 많으며 누군가가이 모든 것을 한 번에 적용 할 수있는 방법은 없습니다. 가능한 한 코드를 가깝게 따라야하며 표준을 정확히 따라야합니다..

내 의견으로는 일관성이 가장 중요한 규칙이다.. 절반 이상을 전환하는 것보다 일관되게 잘못 처리하는 것이 좋습니다. 이는 코드의 기능에 영향을 미치지 않으므로 서식 연습에서는 특히 그렇습니다. 대부분의 경우 - 나중에 쉽게 배치를 변경할 수 있습니다..

당신은 코딩 표준 요소를 싫어합니까? 뭔가를 추가해야한다고 생각합니까? 의견을 통해 알려주십시오.!