댓글 트랩을 피하는 것 : 주석 코드를 리팩터 할 때

몇 주 동안 사용되지 않았을 때 주석 코드를 삭제하는 것이 안전하고 현명합니다. 새로운 논리로 대체, 혼란 또는 소음을 유발하며 버전 제어가 신뢰할 수 있습니다. 2. 댓글 코드는 활성 리팩토링, A/B 테스트 또는 디버깅 데모와 같은 단기 상황에 대해 일시적으로 유지 될 수 있지만 TODO 설명 및 청소 기간이 필요합니다. 3. 안전한 청소 단계에는 다음이 포함됩니다. 삭제를 별도로 제출하고, 테스트 통과를 보장하고, 제출 메시지의 이유를 설명하고, 필요한 경우 팀원의 검토; 4. 최종 원칙은 다음과 같습니다. 주석된 코드는 백업이 아니라 쓰레기입니다. 버전 제어 도구는 코드 기반을 깔끔하게 유지하기 위해 신뢰할 수 있고 쓸모없는 코드를 결정적으로 삭제해야합니다.

당신은 그것을 백 번 보았습니다. 코드 블록은 // /* */ 에 랩을 쳤다. "나중에 필요한 경우를 대비하여"누군가가 생각했습니다. 그러나 진실은 다음과 같습니다. 댓글을 달린 코드는주의로 위장한 기술 부채입니다 . 언제 삭제 해야하는시기와 보관시기를 아는 것은 깨끗하고 유지 된 코딩의 핵심 기술입니다.

소음을 자르고 안전하고 현명한시기에 대해 이야기합시다.

"댓글 함정"이란 무엇입니까?

주석 트랩은 개발자가 전적으로 제거하는 대신 댓글에 사용되지 않은 코드를 남겨두면 발생합니다. 일반적으로 다음과 같습니다.

 // 오래된 인증 방법
// if (user.isvalid ()) {
// 인증 (사용자);
//}

또는 더 나쁜 :

 /*
함수 calculateTax (Oldrate) {
    반품 금액 * Oldrate;
}
*/

이 코드는 실행되지 않지만 여전히 파일을 혼란 스럽게 하고, 새로운 개발자를 혼란스럽게하고, 관련성이있는 척합니다.

우리는 왜 이것을합니까?

• 중요한 것을 잃는 것에 대한 두려움
• 버전 제어에 대한 신뢰 부족
• "돌아올 수도 있습니다"라는 생각

스포일러 : 거의 그렇지 않습니다.

주석 코드를 리팩토링 해야하는 경우 (즉, 삭제)

모든 댓글이 나쁘지는 않지만 거의 항상 댓글을 달린 코드입니다. 다음은 집을 청소할 시간이라는 명확한 징후입니다.

• code 코드는 몇 주 (또는 그 이상)에 사용되지 않았습니다.
  복원하지 않고 며칠 이상 의견에 앉아 있다면 아마 돌아 오지 않을 것입니다.

• ✅ 새로운 작업 논리로 대체됩니다
  함수를 다시 작성하거나 오류 처리가 추가되거나 전환 된 API. 이전 버전은 흑백이 아닙니다.

• ✅ 혼란이나 소음을 유발합니다
  팀원이 물어 보면“이것은 여전히 사용됩니까?” 또는 데드 코드를 구문 분석하는 데 시간을 소비해야하며, 읽기성에 해를 끼칩니다.

• ✅ 버전 제어는 신뢰할 수 있습니다 (해야합니다)
  Git, Mercurial 또는 현대 VC는 전체 역사를 유지합니다. 삭제 된 코드를 항상 검색 할 수 있습니다. 주석에 보관할 필요가 없습니다.

경험 규칙 : git log -S 'functionName' 을 찾을 수 있다면 댓글을 남길 필요가 없습니다.

일시적으로 댓글 코드를 유지할 수 있습니다

드문 예외는 있지만, 수명이 짧고 의도적이어야합니다.

• ? 활성 리팩토링 또는 A/B 테스트 중
  두 구현 사이에 중간 스왑을하고 빠르게 다시 전환 해야하는 경우 일시적인 의견은 괜찮을 수 있습니다. 그러나 Todo와 마감일을 추가하십시오 .

   # TODO : 2025-04-30까지 Old_Payment_Flow를 제거하십시오
  # use_old_flow () :
  # process_legacy_payment ()

• ? 데모 또는 디버깅 컨텍스트
  때때로 당신은 코드에 댓글을 달아서 하지 말아야 할 일을 보여 주거나 버그 재생산 사례를 보존하기 위해 코드를 주석합니다. 이 경우 명확한 설명을 추가하십시오 .

   // 사용하지 않음 : 유인 인종 조건 (문제 #123 참조)
  // fetchData ().
  // fetchData (). // 복제 호출

  그럼에도 불구하고 그러한 예를 문서화 또는 테스트 파일로 옮기는 것을 고려하십시오.

  ---

  안전하게 청소하는 방법

  코드 삭제는 처음에는 무섭게 느껴지지만 올바른 습관으로 힘을 실어줍니다. 다음 단계를 따르십시오.

  • ? 별도의 집중된 PR로 삭제를 커밋하십시오
    제목 명확하게 : "오래된 사용자 인증 로직 제거" - "기타 수정"덤프에 묻혀 있지 않습니다.

  • ? 테스트가 여전히 통과되는지 확인하십시오
    적용 범위가 이전 논리에 의존하지 않았으며 현재 테스트가 새로운 동작을 반영하는지 확인하십시오.

  • ? 커밋 메시지에 이유를 문서화하십시오
    "코드 삭제"대신 : "레거시 인증 흐름 제거 - PR #456의 OAUTH2로 대체".

  • ? 확실하지 않은 경우 팀원과 함께 검토하십시오
    두 번째 눈은 눈이 진정으로 죽었다는 것을 확인하는 데 도움이됩니다.

  ---

  결론

  주석은 코드가 "안전한 유지"가 아닙니다. 혼란 스럽습니다.
  버전 제어 시스템은 백업입니다. 코드베이스는 신중하지 않아야합니다.

  죽은 코드를 삭제하십시오. 도구를 신뢰하십시오. 자신감이있는 리팩토러.

  기본적으로 : 실행되지 않고 일주일에 필요하지 않은 경우 다시 돌아 오지 않을 것입니다. 놓아주세요.

  위 내용은 댓글 트랩을 피하는 것 : 주석 코드를 리팩터 할 때의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!