효과적인 PHP 댓글

PHP 댓글 작성의 열쇠는 명확하고 유용하며 간결합니다. 1. 의견은 복잡한 조건부 판단의 논리적 목적을 설명하는 것과 같이 코드 자체를 설명하기보다는 코드의 의도를 설명해야합니다. 2. 가독성을 향상시키기 위해 마법 값, 이전 코드 호환성, API 인터페이스 등과 같은 주요 시나리오에 주석을 추가합니다. 3. 중복 코드 컨텐츠를 피하고 간결하고 구체적으로 유지하며 PHPDOC와 같은 표준 형식을 사용하십시오. 4. 댓글은 정확도를 보장하기 위해 코드와 동기식으로 업데이트되어야합니다. 좋은 의견은 다른 사람의 관점에서 생각하고 이해 비용을 줄이며 코드 이해 내비게이션 장치가되어야합니다.

PHP 댓글을 작성하는 것은 어렵지 않지만 실제로는, 유용하게, 유용하게, 장황하지 않고 명확하게 쓰는 것이 매우 특별합니다. 많은 사람들이 "이 기능은 무엇을합니까?"라는 글을 쓰는 것과 같이 너무 단순한 의견을 작성합니다. 또는 너무 복잡하고 핵심 사항을 명확하게 볼 수 없습니다. 진정으로 효과적인 PHP 의견은 사람들이 한 눈에 의도를보고 이해 비용을 줄이게해야합니다.

왜 의견을 명확하게 작성해야합니까?

코드가 자체적으로 말할 수 있다고 생각할 수도 있지만 종종 변수 이름과 함수 이름은 논리의 의도를 완전히 표현하지 않습니다. 특히 비즈니스 논리가 더 복잡 할 때, 댓글이없는 경우 도로 표지판이 누락 된 것과 같으며, 다른 사람들 (심지어 자신조차도 코드를보기 위해 돌아올 때 길을 잃기 쉽습니다.

예를 들어:

 if ($ user-> role! == 'admin'&& $ user-> status! == 'active') {
    거짓을 반환합니다.
}

이 코드는 간단 해 보이지만 주석을 추가하면 다음과 같습니다.

 //이 작업은 비 관리자 또는 활성화되지 않은 사용자가 수행 할 수 없습니다.

그러면 전체 판단의 의미가 훨씬 명확합니다.

따라서 주석의 역할은 수행 한 작업을 나타내는 것뿐만 아니라 왜 그것이 수행되는지 설명하는 것입니다.

가장 가치있는 곳은 어디에 있습니까?

모든 코드 라인이 주석이 필요하지는 않지만 다음 시나리오를 권장합니다.

• 복잡한 조건부 판단 : If/Else 또는 중첩 된 논리를 트리플 이상 이상.
• 마법의 값이 알 수없는 소스에서 나오는 경우 : 예를 들어 $type = 3 , 3이 특정 상태 코드 인 경우 의미를 나타내는 것이 가장 좋습니다.
• 이상하지만 오래된 코드를 유지해야합니다 . 때로는 오래된 시스템과 호환 되려면 몇 가지 잘못된 코드를 작성해야하며 의견이 "책임을 부인"하는 데 도움이 될 수 있습니다.
• API 인터페이스 매개 변수 설명 : 특히 반환 값 구조는 발신자에게 매우 중요합니다.

예를 들어:

 /**
 * 사용자 정보 얻기*
 * @param int $ userID 사용자 ID
 * @return 배열에는 이름, 이메일, 역할 필드가 포함되어 있습니다*/
함수 getUserInfo ($ userId) {
    // ...
}

이러한 종류의 다큐멘터리 주석은 IDE에서 자동으로 프롬프트 될 수 있으며 매우 실용적입니다.

그들이“말도 안되는”것이지 않도록 의견을 작성하는 방법?

의견을 작성하는 방법도 있으며 다음 사항을 참조 할 수 있습니다.

• 중복 코드 내용을 피하십시오 : 특별한 이유가없는 한 "제목 설정 $ 제목"과 같은 주석을 작성하지 마십시오.
• 간단하지만 구체적으로 유지하십시오 . 목적을 설명하면 긴 연설을 할 필요가 없습니다.
• 표준 형식 사용 : PHPDOC와 같은 구조화 된 주석이 팀워크에 더 적합합니다.
• 제 시간에 댓글 업데이트 : 코드가 변경되면 주석을 동시에 업데이트해야합니다. 그렇지 않으면 그렇지 않은 것보다 더 나쁩니다.

몇 가지 팁 :

• 논리 단락을 작성한 후에는 주석을 추가 해야하는지 되돌아보십시오.
• 다른 사람들의 코드를 볼 때, 당신을 붙잡는 것에주의를 기울이십시오. 그리고 그것들은 추가해야 할 장소입니다.
• 이해하기 전에 코드를 두 번 읽으면 지금 쓰는 의견은 다른 사람들이 이해해야합니다.

기본적으로 그게 다야

효과적인 주석의 핵심은 다른 사람들의 관점에서 생각하는 것입니다. 코드의 리피터가 아니라 이해를 돕는 네비게이터입니다. 의견을 쓰는 것을 두려워하지 말고 무작위로 쓰지 마십시오. 글을 잘 쓰면 다른 사람들에게 도움이 될뿐만 아니라 미래에 아이디어를 빠르게 찾는 데 도움이됩니다.

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