좋은 vs. 나쁜 PHP 댓글
코드는 코드의 가독성과 유지 보수, 특히 다중 실습 및 장기 유지 보수와 같은 PHP와 같은 프로젝트에서 코드에 중요합니다. 댓글을 작성하는 이유에는 디버깅 시간을 절약하고 초보자에게 친숙하고 의사 소통 비용을 줄이기 위해“왜이를 수행 하는가”를 설명하는 것이 포함됩니다. 좋은 의견의 표현에는 복잡한 논리 의도 표시 할 일 또는 잠재적 문제를 설명하고 API 인터페이스 문서 주석 작성을 설명하기위한 기능 또는 클래스의 역할을 설명하는 것이 포함됩니다. 나쁜 의견의 일반적인 표현에는 코드와 일치하지 않는 반복 코드 컨텐츠 주석이 포함되며 댓글을 사용하여 나쁜 코드를 다루고 이전 정보를 유지하는 것이 포함됩니다. 의견을 작성하기위한 제안서에는 의견 우선 순위를 정하는 이유 "왜 코드와 동기화 된"코드와 동기화하는 이유는 정서적 진술을 피하기 위해 통합 형식을 사용하고 코드를 이해하기 어려울 때 주석에 의존하지 않고 코드 최적화를 고려합니다.
코드를 작성할 때 의견은 많은 사람들이 무시하는 경향이 있지만 가독성에 영향을 줄 가능성이 가장 높습니다. 특히 유연한 구문 및 다양한 프로젝트 구조를 가진 언어 인 PHP에서 좋은 주석은 사람들이 논리를 빠르게 이해하는 데 도움이 될 수 있지만 나쁜 주석은 사람들이 읽을 때 더 혼란 스러울 수 있습니다 .
왜 댓글을 작성합니까?
PHP는 웹 백엔드에서 일반적으로 사용되는 언어입니다. 여러 번 프로젝트가 여러 사람에 의해 완료되며 유지 보수주기가 길다. 현재, 의견은 자신을 상기시켜 줄뿐만 아니라 미래의 사람들을위한 푯말 (미래에 당신을 포함하여)이기도합니다 .
- 의견은 단순히 "무엇을했는지"보다는 "왜"를 설명 할 수 있습니다.
- 복잡한 논리 및 특수 처리 장소, 의견은 많은 디버깅 시간을 절약 할 수 있습니다.
- 초보자에게 친절하고 의사 소통 비용을 줄입니다
따라서 몇 줄의 주석을 과소 평가하지 말고, 다른 사람들이 코드를 볼 때 볼 수있는 첫 번째 인상 일 수 있습니다.
좋은 의견은 어떻게 생겼습니까?
좋은 의견은 더 많지 않지만 더 나은 것은 아니지만 간결하고 정확하며 도움이 되어야합니다. 다음은 일반적인 좋은 주석 관행입니다.
-
함수 또는 클래스의 기능을 설명하십시오
/** * 사용자 로그인 확인 클래스* 프로세스 사용자 이름 및 비밀번호 일치 및 세션 생성 */ 클래스 인증 {} 복잡한 논리를 설명하려는 의도
// 주문 상태는 비동기 콜백으로 업데이트 될 수 있으므로 ($ order-> islocked ()) {인 경우 동시성 문제를 방지하기 위해 여기서 잠금이 필요합니다. 거짓을 반환합니다. }할 일 또는 잠재적 문제 태그
// TODO : 다국어를 지원해야합니다. 현재 기본 중국어 $ greeting = "Hello";
API 인터페이스 문서 주석
/** * 사용자 정보를 얻으십시오* @param int $ useriD 사용자 ID * @return array | false 사용자 데이터 또는 거짓을 반환하지 못했습니다. */ 함수 getUserInfo ($ userId) {...}
이 의견은 핵심을 지적합니다. 다른 사람들이 한 눈에 무엇을하고 있는지 알리고 코드에 깊이 들어 가지 않고도 논리를 이해할 수 있습니다 .
나쁜 의견의 전형적인 예는 무엇입니까?
나쁜 의견이 반드시 잘못된 것은 아니지만 종종 중복, 오해의 소지가 있거나 구식 또는 말도 안됩니다 . 다음은 전형적인 반례입니다.
의미없는 코드 내용을 반복하십시오
$ I; // 하나를 추가합니다
의견과 코드는 일관성이 없습니다
// 기사 목록을 가져옵니다. $ data = getCategories (); // 그러나 실제로 분류를 받고 있습니다
코드를 여러 주석으로 다루십시오
// foreach ($ 항목으로 $ ait) {데이터 처리 시작 {{ // 유효한 지 여부를 결정합니다 ($ item [ 'status'] == 1) { // 결과에 추가 $ result [] = $ item; } } // 데이터 처리 종료이 상황은 실제로 주석에 의해 "설명"하기보다는 기능 이름이나 변수 이름에 더 적합합니다.
-
오래된 의견은 여전히 제자리에 있습니다
예를 들어, 함수는 매개 변수를 변경했지만 주석에는 여전히 기존 버전의 정보가 포함되어 있으며, 이는 주목하는 것보다 훨씬 더 끔찍합니다.
댓글 작성에 대한 제안
- "무엇을했는지"보다는 "왜"에 대한 주석을 우선시하는
- 주석과 코드를 동시에 업데이트하십시오
- PHPDOC와 같은 통합 형식을 사용하여 기능 주석을 작성하십시오.
- 감정적이거나 냉소적 인 진술을 피하십시오 (팀이 스타일이라는 것을 알지 않는 한)
코드를 이해하기 쉽다고 생각조차하지 않는다면 주석을 추가하는 것이 가장 좋습니다. 그러나 댓글을 추가 한 후에도 여전히 짓밟 히고 있다고 생각되면 코드 자체를 최적화 해야하는지 고려해야합니다.
기본적으로 그게 다야.
위 내용은 좋은 vs. 나쁜 PHP 댓글의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!
핫 AI 도구
Undress AI Tool
무료로 이미지를 벗다
Undresser.AI Undress
사실적인 누드 사진을 만들기 위한 AI 기반 앱
AI Clothes Remover
사진에서 옷을 제거하는 온라인 AI 도구입니다.
Clothoff.io
AI 옷 제거제
Video Face Swap
완전히 무료인 AI 얼굴 교환 도구를 사용하여 모든 비디오의 얼굴을 쉽게 바꾸세요!
인기 기사
뜨거운 도구
메모장++7.3.1
사용하기 쉬운 무료 코드 편집기
SublimeText3 중국어 버전
중국어 버전, 사용하기 매우 쉽습니다.
스튜디오 13.0.1 보내기
강력한 PHP 통합 개발 환경
드림위버 CS6
시각적 웹 개발 도구
SublimeText3 Mac 버전
신 수준의 코드 편집 소프트웨어(SublimeText3)
램프 스택 너머 : 현대 기업 아키텍처에서 PHP의 역할
Jul 27, 2025 am 04:31 AM
PhpisstillRelevantinmodernenterpriseenvironments.1. Modernphp (7.xand8.x)는 엄격한 성능, 엄격한 성능, jitcompilation 및 modernsyntax, mateitsuilableforlarge-scalepplications
PHP의 객체 관계 매핑 (ORM) 성능 튜닝
Jul 29, 2025 am 05:00 AM
N 1 쿼리 문제를 피하고 관련 데이터를 미리로드하여 데이터베이스 쿼리 수를 줄입니다. 2. 메모리와 대역폭을 저장하기 위해 완전한 엔티티를로드하지 않도록 필요한 필드 만 선택하십시오. 3. 교리의 2 차 캐시 또는 Redis 캐시 고주파 쿼리 결과와 같은 캐시 전략을 합리적으로 사용하십시오. 4. 엔티티 수명주기를 최적화하고 정기적으로 Clear ()을 호출하여 메모리를 자유롭게하여 메모리 오버플로를 방지합니다. 5. 데이터베이스 색인이 존재하는지 확인하고 비효율적 인 쿼리를 피하기 위해 생성 된 SQL 문을 분석하십시오. 6. 변경 사항이 필요하지 않은 시나리오에서 자동 변경 추적을 비활성화하고 배열 또는 경량 모드를 사용하여 성능을 향상시킵니다. ORM을 올바르게 사용하려면 개발 효율을 유지하면서 응용 프로그램 성능을 보장하기 위해 SQL 모니터링, 캐싱, 배치 처리 및 적절한 최적화를 결합해야합니다.
PHP 및 RabbitMQ로 탄력성 마이크로 서비스 구축
Jul 27, 2025 am 04:32 AM
유연한 PHP 마이크로 서비스를 구축하려면 RabbitMQ를 사용하여 비동기 통신을 달성하고 1. 캐스케이드 고장을 피하기 위해 메시지 대기열을 통해 서비스를 분리해야합니다. 2. 신뢰성을 보장하기 위해 지속적인 대기열, 지속적인 메시지, 확인 및 수동 ACK를 구성합니다. 3. 지수 백 오프 재 시도, TTL 및 데드 레터 큐 보안 처리 실패를 사용하십시오. 4. Supervisord와 같은 도구를 사용하여 소비자 프로세스를 보호하고 서비스 건강을 보장하기 위해 하트 비트 메커니즘을 가능하게합니다. 그리고 궁극적으로 시스템이 실패로 지속적으로 작동하는 능력을 실현합니다.
PHP 용 생산 준비 도커 환경 생성
Jul 27, 2025 am 04:32 AM
올바른 PHP 기본 이미지를 사용하고 안전하고 성능 최적화 된 Docker 환경을 구성하는 것이 생산 준비를위한 핵심입니다. 1. PHP : 8.3-fpm-alpine을 기본 이미지로 선택하여 공격 표면을 줄이고 성능을 향상시킵니다. 2. 사용자 정의 php.ini를 통해 위험한 기능을 비활성화하고, 오류 표시를 끄고, Opcache 및 JIT를 활성화하여 보안 및 성능을 향상시킵니다. 3. Nginx를 리버스 프록시로 사용하여 민감한 파일에 대한 액세스를 제한하고 PHP 요청을 PHP-FPM으로 올바르게 전달합니다. 4. 다단계 최적화 이미지를 사용하여 개발 종속성을 제거하고 컨테이너를 실행하도록 뿌리가 아닌 사용자를 설정하십시오. 5. CRON과 같은 여러 프로세스를 관리하기위한 선택적 감독 조종; 6. 배포 전에 민감한 정보 누출이 없는지 확인하십시오
vscode settings.json 위치
Aug 01, 2025 am 06:12 AM
settings.json 파일은 사용자 수준 또는 작업 공간 수준 경로에 있으며 VSCODE 설정을 사용자 정의하는 데 사용됩니다. 1. 사용자 수준 경로 : Windows는 C : \ Users \\ AppData \ Roaming \ Code \ User \ Settings.json, MacOS IS /users//library/applicationsupport/code/user/settings.json, linux는 /home//.config/code/user/settings.json; 2. Workspace 수준 경로 : .vscode/settings project root 디렉토리
Readonly 속성으로 PHP에 불변의 물체를 구축합니다
Jul 30, 2025 am 05:40 AM
readOnlyPropertiesInphp8.2CanonlyBeassignedOnedOneDonceIntheConstructorAratDeclarationandCannotBemodififificificificifified
Serverless Revolution : BREF를 사용하여 확장 가능한 PHP 응용 프로그램을 배포합니다
Jul 28, 2025 am 04:39 AM
BREF를 통해 PHP 개발자는 서버를 관리하지 않고 확장 가능하고 비용 효율적인 응용 프로그램을 구축 할 수 있습니다. 1. Bref는 최적화 된 PHP 런타임 레이어를 제공하고 PHP8.3 및 기타 버전을 지원하며 Laravel 및 Symfony와 같은 프레임 워크와 완벽하게 통합하여 PHP를 Awslambda에 가져옵니다. 2. 배포 단계에는 다음이 포함됩니다 : Composer를 사용하여 BREF 설치, HTTP 엔드 포인트 및 장인 명령과 같은 기능 및 이벤트를 정의하기 위해 Serverless.yml 구성; 3. ServerlessDeploy 명령을 실행하여 배포를 완료하고 APIGINGWARE를 자동으로 구성하고 액세스 URL을 생성합니다. 4. Lambda 제한을 위해 Bref는 솔루션을 제공합니다.
PHP의 내부 쓰레기 수집 메커니즘에 대한 깊은 다이빙
Jul 28, 2025 am 04:44 AM
PHP의 쓰레기 수집 메커니즘은 기준 계수를 기반으로하지만주기적인 원형 쓰레기 수집기에 의해 순환 참조가 처리되어야합니다. 1. 기준 카운트 변수에 대한 참조가 없을 때 즉시 메모리를 방출합니다. 2. 참조 기준으로 메모리가 자동으로 해제 될 수 없게되며 GC에 따라 다르며이를 감지하고 청소합니다. 3. "가능한 루트"zval이 임계 값에 도달하거나 수동으로 GC_COLLECT_CYCLES ()를 호출 할 때 GC가 트리거됩니다. 4. 장기 실행 PHP 응용 프로그램은 메모리 누출을 피하기 위해 GC_STATUS ()를 모니터링하고 GC_COLLECT_CYCLES ()를 제 시간에 호출해야합니다. 5. 모범 사례에는 원형 참조를 피하고 GC_DISABLE ()를 사용하여 성능 키 영역을 최적화하고 ORM의 CLER () 메소드를 통해 DeReeference 객체를 포함합니다.
