[Clean Code] 주석

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

표현력이 풍부하고 깔끔하여 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

코드로 의도를 표현하라

코드로 대다수 의도를 표현할 수 있다. 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

//직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))

주석이 없음에도 아래쪽 코드로 의도를 표현할 수 있다.

if (employee.isEligibleForFullBenefits())

좋은 주석

---

어떤 주석은 필요하거나 유익하다.

법적인 주석

• 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.

//Copyright (c) 2003,2004,2005 by Object Mentor, Inc. All rights reserved.
//GNU General Public License 버전 2 이상을 따르는 조건으로 배포한다.

정보를 제공하는 주석

• 때로는 기본적인 정보를 주석으로 제공하면 편리하다.

//테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance();

때로는 위와 같은 주석이 유용하다고 할지라도, 가능하다면, 함수 이름에 정보를 담는 편이 더 좋다.

//kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile( "\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*")

위에 제시한 주석은 코드에서 사용한 정규표현식이 시간과 날짜를 뜻한다고 설명한다.
이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 깔끔하겠다.

의도를 설명하는 주석

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

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

• 때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.

assertTrue(a.compareTo(a) ==0 );  //a == a
assertTrue(a.compareTo(b) !=0 );  // a != b
assesrtTrue(a.compareTo(b) == -1 );  // a < b

그릇된 주석을 달아놓을 위험 또한 상당히 높다.
그러므로 위와 같은 주석을 달 때는 더 나은 방법이 없는지 고민하고 정확히 달도록 각별히 주의한다.

결과를 밝히는 주석

• 때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.

public static SimpleDateFormat makeStandardHtpDateFormat(){
    //SimpleDateFormat은 스레드에 안전하지 못하다.
    //따라서 각 인스턴스를 독립적으로 생성해야 한다.
    SimpleDateFormat df = new SimpleDateFormat("EEE, dd MM yyyy HH:mm:ss z");
    df.setTimeZone(TimeZone.getTimeZone("GMT));
    return df;
}

위의 코드에서 프로그램 효율을 높이기 위해 정적 초기화 함수를 사용하려던 열성적인 프로그래머가 주석 때문에 실수를 면할 수 있다.

TODO 주석

• 때로는 ‘앞으로 할 일’을 //TODO 주석으로 남겨두면 편하다.

//TODO-MdM 현재 필요하지 않다.
//체크아웃 모델을 도입하면 함수가 필요 없다.
protected VersionInfo makeVersion() throws Exception{
    return null;
}

TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
래도 TODO가 많은 코드는 바람직하지 않으므로 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애야 한다.

중요성을 강조하는 주석

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

String listItemContent = match.group(3).trime();
//여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.
//문자열에 시작 공백이 있으면 다른 문자열로 인식되기 떄문이다.
new ListItemWidget(this, listItemContent, this.level + 1);
return buildList(text.substring(match.end()));

공개 API에서 Javadocs 설명이 잘 된 공개 API는 유용하고 만족스럽다. 하지만 여느 주석과 마찬가지로 Javadocs 역시 독자를 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달한 가능성이 존재한다.

나쁜주석

---

대다수 주석이 이 범주에 속한다.

주절거리는 주석

특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다.

• 이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트만 낭비할 뿐이다.

같은 이야기를 중복하는 주석

• 자칫하면 코드보다 주석을 읽는 시간이 더 오래 걸린다.

//this.closed가 true일 때 반환되는 유틸리티 메서드다.
//타임아웃에 도달하면 예외를 던진다.
public synchronized void waitForClose(final long timeoutMillis)
throws Exception{ ... }

오해할 여지가 있는 주석

• 주석에 담긴 ‘살짝 잘못된 정보’로 인해 this.closed가 true로 변하는 순간에 함수가 반환되리라는 생각으로 어느 프로그래머가 경솔하게 함수를 호출할지도 모른다.

의무적으로 다는 주석

• 오히려 코드만 헷갈리게 만들며, 거짓말할 가능성을 높이며, 잘못된 정보를 제공할 여지만 만든다.
  • @param title CD 제목
  • @param author CD 저자
  • @param tracks CD 트랙 숫자 */ ~

이력을 기록하는 주석(git history를 이용하자!)

• 예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했다.
• 하지만 소스 코드 관리 시스템이 있는 이제는 혼란만 가중할 뿐이다. 완전히 제거하는 편이 좋다.

있으나 마나 한 주석

• 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.

/**
  *기본생성자
*/
protected AnnualDateRule(){
}

무서운 잡음

• 때로는 Javadocs도 잡음이다.
• 단지 문서를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음일 뿐이다.
• 함수나 변수로 표현할 수 있다면 주석을 달지 마라

/** The name */
private String name;

/** The version. */
private String version;

//전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))

이 코드에서 주석을 없애고 다시 표현하면 다음과 같다.
ArrayList moduleDependees = smodule.getDependSubsystems();
String ourSubSsytem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))

위치를 표시하는 주석

• 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.
• 배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다.
• 닫는 괄호에 다는 주석
  • 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화된 함수에는 잡음일 뿐이다.
  • 그러므로 닫는 괄호에 주석을 달아야겠다는 생가이 든다면 대신에 함수를 줄이려 시도하자.

try{
    while(){
    ...
    } //while
} // try

공로를 돌리거나 저자를 표시하는 주석

• 소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 기억한다.
• 저자 이름으로 코드를 오염시킬 필요가 없다.

주석으로 처리한 코드

• 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다.
  • HTML 주석(Javadocs와 같은)
    • 도구로 주석을 뽑아 웹 페이지에 올릴 작정이라면 주석에 HTML 태그를 삽입해야 하는 책임은 프로그래머가 아니라 도구가 져야한다.
  • 전역 정보
    • 주석을 달아야 한다면 근처에 있는 코드만 기술하라.
    • 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
  • 너무 많은 정보
    • 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
  • 모호한 관계
    • 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
  • 함수 헤더
    • 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
  • 비공개 코드에서 Javadocs
    • 공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 javadocs는 쓸모가 없다.
    • 유용하지 않을 뿐만 아니라 Javadocs주석이 요구하는 형식으로 인해 코드만 보기 싫고 산만해 질 뿐이다.