나쁜 코드에 주석을 달지 마라. 새로 짜라.

Overview

주석은 필요악이다. 우리가 코드로 의도를 표현하지 못해, 주석을 사용한다. 주석은 언제나 실패를 뜻한다. 그러므로 주석이 필요한 상황이 생긴다면 곰곰이 생각하기 바란다. 상황을 역전해 코드로 의도를 표현할 방법을 생각해야 한다.

주석을 오래될수록 코드에서 멀어지며, 완전히 그릇될 가능성도 커진다. 이유는 개발자들이 주석을 유지하고 보수하기란 현실적으로 불가능하기 때문이다. 코드는 변화하고 진화한다. 일부가 여기서 저기로 옮겨지기도 한다. 하지만, 주석이 언제나 코드를 따라가지 못한다.

주석을 나쁜 코드를 보완하지 못한다.

  • 코드에 주석을 추가하는 이유는 코드 품질이 나쁘기 때문이다. 지저분한 코드라는 것을 자각하고 주석을 추가하려 한다.
  • 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
  • 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!

코드로 의도를 표현하라.

  • 조금 더 생각하면 코드로 대다수의 의도를 표현할 수 있다.
  • 아래 코드를 보자.
1
2
3
4
5
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다. 코드를 통해 의도를 파악하기 힘들다.
if((employee.flags && HOURLY_FLAG) && employee.age > 65)

// 개선된 코드
if(employee.isEligibleForFullBenefits())
  • 이처럼 많은 경우, 주석을 달려는 설명을 함수로 만들어 표현해도 충분하다.

좋은 주석

  • 어떤 주석을 필요하거나 유익하다.
  • 분명, 주석은 필요악이라 했는데, 모순되는 것 아닌가?! 하지만, 몇 가지 경우가 있다.
  • 그래도 좋은 주석은, 주석을 달지 않은 방법을 찾아낸 주석이다.

[법적인 주석]

  • 회사가 정립한 구현 표준에 맞춰 법적인 이유로 넣어야 하는 경우
  • ex) 저작권 정보와 소유권 정보

[정보를 제공하는 주석]

  • 때로는 기본적인 정보를 주석으로 제공하면 편리하다.
  • 아래 주석은 정규표현식이 시각과 날짜를 뜻한다고 설명한다.
1
2
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile("\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*");
  • 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 깔끔하겠다. 그러면 주석이 필요없어진다.

[의도를 설명하는 주석]

  • 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.

[의미를 명료하게 밝히는 주석]

  • 때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
  • 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
  • 그릇된 주석을 달아놓은 위험이 상당히 높다. 주석이 올바른지 검증하기 쉽지 않다. 이것이 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유이기도 하다.

[결과를 경고하는 주석]

  • 때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
  • ex) 다음은 특정 테스트 케이스를 꺼야 하는 이유를 설명하는 주석이다.
1
2
3
4
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile(){
    ...
}
  • 요즘에는 @Ignore 속성을 이용해 테스트 케이스를 꺼버린다. 구체적인 설명은 @Ignore 속성에 문자열로 넣어준다.
  • 아래는 주석이 아주 적절한 예제다.
1
2
3
4
5
6
7
public static SimpleDateFormat makeStandardHttpDateFormat(){
    // SimpleDateFormat은 스레드에 안전하지 못하다.
    // 따라서 각 인스턴스를 독립적으로 생성해야 한다.
    SimpleDateFormat df = new SimpleDateFormat("EEE, dd MMM  yyyy HH:mm:ss z");
    df.setTimeZone(TimeZone.getTimeZone("GMT"));
    return df;
}

[TODO 주석]

  • '앞으로 할 일’을 TODO 주석으로 남겨두면 편하다.
  • 개발자가 필요하다 여기지만, 당장 구현하기 어려운 업무를 기술한다.
  • ex) 더이상 필요 없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁 등등
  • 하지만, 어떤 용도로 사용하든 시스템에 나쁜 코드를 남겨 놓는 핑계가 되어서는 안된다.

[중요성을 강조하는 주석]

  • 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다.

[공개 API에서 Javadocs]

  • 설명이 잘 된 공개 API는 유용하고 만족스럽다. 표준 자바 라이브러리에서 사용한 Javadocs가 좋은 예다.
  • 공개 API를 구현한다면 훌륭한 Javadocs를 작성해라. 다만, 여기서 설명한 규칙을 명심해야 한다.

나쁜 주석

  • 대다수의 주석은 이 범주에 속한다.
  • 주절거리는 주석
    • 특별한 이유 없이 다는 주석이다.
  • 같은 이야기를 중복하는 주석
  • 오해할 여지가 있는 주석
  • 의무적으로 다는 주석
    • 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석다. 이로 인해 코드가 복잡해지며, 혼동과 무질서를 초래한다.
  • 이력을 기록하는 주석
    • 예전에는 소스 코드 관리 시스템이 없으니, 이러한 관례가 바람직했다. 하지만, 요즘은 있으니 이러한 실수를 하지 않도록 하자.
  • 있으나 마나 한 주석
    • 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석. 이러한 주석을 달지 말고 코드를 정리해라.
  • 함수나 변수로 표현할 수 있다면 주석을 달지 마라
    • 주석 대신, 함수로 표현하여 코드를 개선하라.
  • 위치를 표시하는 주석
  • 닫는 괄호에 다는 주석
    • 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만, 우리가 선호하는 작고 캡슐화된 함수에는 잡음일 뿐이다.
  • 공로를 돌리거나 저자를 표시하는 주석
    • 이러한 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.
  • 주석으로 처리한 코드
    • 이러한 코드는 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안된다고 생각한다. 쓸모 없는 코드가 쌓여간다.
  • HTML 주석
    • 읽기 어려우며, 혐오 그 자체다.
  • 전역 정보
    • 주석을 달아야 한다면 근처에 있는 코드만 기술하라.
    • 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
  • 너무 많은 정보
    • 그러는 사람은 없겠지만, 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
  • 모호한 관계
    • 주석을 달았다면 주석과 코드를 읽고 무슨 의미인지 알 수 있어야 한다.
  • 함수 헤더
    • 짧은 함수는 긴 설명이 필요 없다.
    • 짧고 한 가지만 수행하며, 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.

Reference