[클린 코드] 4장: 주석

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

잘 달린 주석은 어떤 정보보다 유용하다. 하지만 대부분의 경우는 그렇지 않다. 오히려 코드를 이해하기 어렵게 만들고, 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨린다. 주석은 '순수하게 선하지' 못하다.

 

주석은 고의가 아니더라도 거짓말을 할 수 있다. 주석은 오래될수록 코드에서 멀어진다. 주석까지 유지보수하기란 불가능하다. 

 

코드는 변화하고 진화한다. 주석이 언제나 코드를 따라갈 수는 없다. 따라서 가능한 주석을 줄이도록 노력해야 한다.

 

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 

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

즉, 앞서 말한 것처럼 나쁜 코드를 주석으로 커버하려 하지 말고, 나쁜 코드를 개선하는 데 시간을 보내라!

 

코드로 의도를 표현하라

코드로 의도를 설명하기 어려운 경우도 존재하지만, 대다수의 경우 코드로 의도를 표현할 수 있다. 즉, 아래와 같이 주석으로 표현하지 말고

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

아래와 같이 코드로 의도를 드러내라.

if (employee.isEligibleForFullBenefits())

좋은 주석

어떤 주석은 필요하거나 유익하다. 그러나 잊어서는 안되는 사실은, 가장 최선의 선택은 주석을 달지 않고 의도를 드러낼 수 있는 것이다!

 

• 법적인 주석

때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣을 수 있다. 저작권 관련 주석 등이 이에 포함된다. 

 

• 정보를 제공하는 주석

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

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

그러나 이런 경우라도 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨줏면 주석이 필요 없어질 것이다.

 

• 의도를 설명하는 주석

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

// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
for (int i = 0; i < 25000; i++) {
	스레드 생성;
    스레드 시작;
}

 

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

때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다. 일반적으로는 인수나 반환값 자체를 명확하게 만들면 좋겠지만 표준 라이브러리라던가, 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.

WikiPagePath a = PathParser.parse("PageA");
WikiPagePath b = PathParser.parse("PageB");

assertTrue(a.compareTo(b) == 1); // a > b

 

• 결과를 경고하는 주석

때로는 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다. 다음은 특정 테스트케이스를 꺼야 하는 이유를 설명하는 주석이다.

// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile() {
	...
}

물론 @Ignore 라는 어노테이션을 사용하면 되지만, 개념적으로는 위와 같은 상황이 적절한 예시이다.

 

 

• TODO 주석

때로는 앞으로 할 일을 TODO 주석으로 남겨두면 편하다. 필요하다 여기지만 당장 구현하기 어려운 업무를 기술할 때 사용한다. 그러나 이를 떡칠해서 사용하면 안되고, 주기적으로 IDE의 검색 기능을 이용해 TODO 주석을 제거해라.

 

// TODO 무슨무슨 부분이 변경되어야 한다.
public VersinInfo makeVersion() {
	...
}

 

• 중요성을 강조하는 주석

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

 

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

 

• 공개 API에서 Javadocs

공개 API를 구현한다면 반드시 훌륭한 Javadocs를 작성한다. 하지만 명심해야 하는 것은, Javadocs 역시 주석이기 때문에 독자를 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재한다. 

 

나쁜 주석

대다수 주석이 이 범주에 속한다. 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머의 독백에서 크게 벗어나지 못한다.

 

• 주절거리는 주석

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

 

try {
	String propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE;
    FileInputStream propertiesStream = new FileInputStream(propertiesPath);
    loadedProperties.load(propertiesStream);
 } catch (IOException e) {
 	// 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
 }

 

catch 블록 내의 주석은 무슨 뜻일까? 저자야 의미를 알겠지만, 독자는 의미를 알지 못한다. 답을 알아내기 위해선 다른 코드를 뒤져봐야 한다. 이런 주석은 바이트만 낭비할 뿐이다.

 

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

코드에서 전하는 의미를 주석으로 작성하지 마라. 코드가 의미를 전달한다면 주석은 필요 없다.

 

// 두 정수형의 합을 반환한다.
public int adder(int x, int y) {
	return x + y;
}

 

• 오해할 여지가 있는 주석

주석은 언어이기 때문에 조그마한 실수로 오해할 여지가 생기기도 한다.

 

// this.closed가 true일 때 반환되는 유틸리티 메서드이다.

this.closed가 true로 변하는 순간을 의미하는 것인가, this.closed가 true일 때를 의미하는 것인가? 이 경우 혼란을 야기하기 쉽다.

 

• 의무적으로 다는 주석

모든 함수에 Javadocs를 다는 등.. 의무적으로 다는 주석은 무질서를 초래한다. 

 

• 이력을 기록하는 주석

* 12-Nov-2001 : 버그를 수정했다.
* 05-Dec-2001 : 무슨무슨 클래스를 없앴다.

이런식으로 작성하지 마라. 지금은 훌륭한 소스 코드 관리 시스템이 존재한다.

 

• 위치를 표시하는 주석

아래와 같은 배너를 삽입하는 경우도 있는데, 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.

//// ACTIONS ////

 

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

소스 코드 관리 시스템으로 표현이 가능하다. 없애자.

 

• 주석으로 처리한 코드

주석으로 처리한 코드만큼 밉살스러운 관행도 드물다. 지우지 않으면 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다. 이 역시 소스 코드 프로그램이 있으니, 없애버리자.

 

• 전역 정보

주석을 달아야 한다면 근처에 있는 코드만 기술해라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.

 

 

• 너무 많은 정보

주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라. 무의미한 내용은 제거해라.

 

/*
아리토스테네스의 체는 몇년도에 고안되었으며 ...
그는 무엇을 좋아했고 ...
이것이 좋은 알고리즘인 이유는 ...
*/

 

• 모호한 관계

주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. 

 

/*
* 모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다).
* 그리고 헤더 정보를 위해 200 바이트를 더한다.
*/

 

여기서 필터 바이트란 무엇인가? 설명을 필요로 하는 주석은 의미 없다.