PHP 댓글 작성 팁

PHP 의견을 작성하는 열쇠는 목적과 사양을 명확히하는 것입니다. 의견은 중복성이나 너무 단순성을 피하고 "수행 된 것"보다는 "왜"를 설명해야합니다. 1. 클래스 및 메소드 설명에 DocBlock (/*/)과 같은 통합 형식을 사용하여 가독성 및 도구 호환성을 향상시킵니다. 2. JS 점프가 수동으로 출력 해야하는 이유와 같은 논리의 이유를 강조합니다. 3. 복잡한 코드 전에 개요 설명을 추가하고 프로세스를 단계적으로 설명하고 전체 아이디어를 이해하는 데 도움이됩니다. 4. TODO 및 FIXME를 사용하여 쉽게 후속 추적 및 협업을 위해 할 일 항목과 문제를 합리적으로 표시하십시오. 주석이 양호하면 통신 비용을 줄이고 코드 유지 보수 효율성을 향상시킬 수 있습니다.

PHP 의견을 작성하는 것은 실제로 기술적 인 일이며 설명해야 할 몇 줄은 아닙니다. 좋은 주석은 귀하와 다른 사람들이 코드 논리를 더 빨리 이해하고 커뮤니케이션 비용을 줄이며 나중에 유지 보수를 용이하게하는 데 도움이 될 수 있습니다. 그러나 많은 사람들이 너무 단순하거나 너무 긴 바람을 쓴다고 말하면서 비생산적인 영향을 줄 수 있습니다.

다음은 PHP 의견을 실제로 작동시키기위한 몇 가지 실용적인 팁입니다.

명확한 형식의 스타일을 통합하십시오

PHP 주석을 작성하는 두 가지 일반적인 방법이 있습니다. // 한 줄의 경우 /* */ 또는 /** */ 여러 줄에 대해. 문서 블록 (클래스 및 메소드 설명과 같은) 인 경우 /** */ docblock 형식을 사용하는 것이 좋습니다.이 형식은 IDE 및 도구로 문서를 생성 할 수 있습니다.

예를 들어:

 /**
 * 프로세스 사용자 로그인 요청*
 * @Param String $ username username * @param String $ password password * @return bool 로그인 */
함수 로그인 ($ username, $ password) {
    // ...
}

일관된 형식을 유지하는 것은 좋아 보일뿐만 아니라 팀워크를 더 매끄럽게 만듭니다.

의견은 "무엇을했는지"가 아니라 "왜"를 설명해야합니다.

많은 사람들의 의견은 코드를 반복하고 다음과 같은 일을합니다.

 $ I; // i의 값을 증가시킵니다

이런 종류의 의견은 의미가 없습니다. 설명해야 할 것은이 코드가 수행되는 이유입니다. 예를 들어:

 // 일부 브라우저는 점프 헤드를 지원하지 않기 때문에 js 점프 echo "<cript> window.location.href = &#39;$ url&#39;</script>";

이런 식으로 보는 사람들은 표면 작용을 보는 것이 아니라이 논리의 이유를 알게 될 것입니다.

복잡한 논리 전에 요약 설명을 추가하십시오

복잡한 판단 또는 루프 중첩과 같은 특정 코드가 논리적으로 엉키 든 경우 전반적인 아이디어를 설명하기 위해 작은 단락을 추가 할 수 있습니다. 예를 들어:

 /*
 * 사용자 권한 프로세스 확인 :
 * 1. Session First* 2에서 사용자 역할을 얻습니다. 그런 다음 현재 페이지를 기준으로 권한 테이블을 일치시킵니다.* 3. 권한이 없으면 홈페이지*/로 점프하십시오.

이러한 의견은지도와 같습니다. 사람들이 코드의 일반적인 방향을 빠르게 이해하도록 돕습니다.

Todo와 Fixme의 역할을 무시하지 마십시오

개발 과정에서 // TODO: 할 일 항목을 표현하고 // FIXME: 알려진 문제를 표시하는 데 사용할 수 있습니다. 많은 편집자가 후속 검색을 위해 이러한 태그를 식별하는 것을 지원합니다.

예를 들어:

 // todo : 로깅 함수가 추가되어야합니다. // fixme : 현재 로직은 특정 상황에서 오류를보고합니다.

이 정보는 특히 팀워크에 유용하며 다른 사람들이 그 장소가 여전히 "반제품"상태에 있음을 알 수 있습니다.

기본적으로 그게 다야. 메모는 작게 보이지만 실제로 잘해야한다면 인내심과 경험이 필요합니다. 핵심은 다른 사람들의 관점에서, 코드를 볼 때 가장 알고 싶어하는 것을 생각한 다음 지침의 일부를 추가하는 것입니다.

위 내용은 PHP 댓글 작성 팁의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!