Skip to main content Link Search Menu Expand Document (external link) Copy Copied

클린 코드 작성 가이드라인

  1. 코드 악취를 최대한 줄여야 한다
    • 리팩터링은 코드 커밋 전에 완료해야 한다
  2. 나쁜 주석을 남기지 않는다
    • 필요한 경우에만 주석을 사용한다
  3. 주석 안에 코드를 남기지 않는다
    • 주석 처리한 코드를 체크인하는 것은 절대로 허용되지 않는다
  4. 죽은 코드를 남기지 않는다
    • 실행되지 않거나 결과가 없는 코드는 삭제한다
  5. 긴 식별자 이름을 피한다
    • 책임이 많거나 기술 용어가 너무 많은 식별자는 사용하지 않는다
  6. 매직 상수를 남기지 않는다
    • 불분명한 숫자나 리터럴 값은 명시적으로 정의한다
  7. 제대로 처리되지 않은 예외를 남기지 않는다
    • 비어있는 catch 블록은 사용하지 않는다
    • 일반적인 예외만으로는 정보가 부족하므로, 상세한 정보를 담은 메시지로 옮긴다

클린 코드에 대한 의견

  • 코드는 주석 없이도 잘 이해할 수 있어야 한다
  • 예외 처리는 코드의 안정성을 높이는 중요한 요소이다
  • 여기서 제시한 가이드라인은 유지보수 가능한 코드를 작성하는 데 필요한 중요한 규칙들이다