클린코드 (2) 주석
주석은 필요악이다. 코드로 의도를 표현하지 못해서 주석을 사용한다. 주석을 최소화하는 방법을 알아보자.
1. 주석은 나쁜 코드를 보완하지 못한다
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 모듈을 짜고 보니 짜임새가 엉망이고 알아먹기 어렵다. 그래서 주석을 달아야겠다고 생각한다. 하지만 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
// Bad - 주석으로 설명하는 나쁜 코드
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))
// Good - 코드로 의도를 표현
if (employee.isEligibleForFullBenefits())
2. 좋은 주석
2.1 법적인 주석
회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시하는 경우가 있다.
// Copyright (C) 2022 by ABC, Inc. All rights reserved.
// GNU General Public License version 2.0
2.2 정보를 제공하는 주석
기본적인 정보를 주석으로 제공하면 편리하다. 하지만 가능하면 함수 이름에 정보를 담는 편이 더 좋다.
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile(
"\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*");
2.3 의도를 설명하는 주석
때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
public int compareTo(Object o) {
if (o instanceof WikiPagePath) {
WikiPagePath p = (WikiPagePath) o;
String compressedName = StringUtil.join(names, "");
String compressedArgumentName = StringUtil.join(p.names, "");
return compressedName.compareTo(compressedArgumentName);
}
return 1; // 오른쪽 유형이므로 정렬 순위가 더 높다.
}
2.4 의미를 명료하게 밝히는 주석
인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
assertTrue(a.compareTo(a) == 0); // a == a
assertTrue(a.compareTo(b) != 0); // a != b
assertTrue(ab.compareTo(ab) == 0); // ab == ab
assertTrue(a.compareTo(b) == -1); // a < b
assertTrue(aa.compareTo(ab) == -1); // aa < ab
assertTrue(ba.compareTo(bb) == -1); // ba < bb
2.5 결과를 경고하는 주석
다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile() {
writeLinesToFile(10000000);
// ...
}
public static SimpleDateFormat makeStandardHttpDateFormat() {
// SimpleDateFormat은 스레드에 안전하지 못하다.
// 따라서 각 인스턴스를 독립적으로 생성해야 한다.
SimpleDateFormat df = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z");
df.setTimeZone(TimeZone.getTimeZone("GMT"));
return df;
}
2.6 TODO 주석
앞으로 할 일을 TODO 주석으로 남겨두면 편하다. 하지만 나쁜 코드를 남겨두는 핑계가 되어서는 안 된다.
// TODO: 현재 필요하지 않다.
// 체크아웃 모델을 도입하면 함수가 필요 없다.
protected VersionInfo makeVersion() throws Exception {
return null;
}
2.7 중요성을 강조하는 주석
자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다.
String listItemContent = match.group(3).trim();
// 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.
// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.
new ListItemWidget(this, listItemContent, this.level + 1);
return buildList(text.substring(match.end()));
2.8 공개 API에서 Javadocs
공개 API를 구현한다면 반드시 훌륭한 Javadocs를 작성한다.
/**
* 사용자 정보를 조회합니다.
*
* @param userId 조회할 사용자의 ID
* @return 사용자 정보를 담은 User 객체
* @throws UserNotFoundException 해당 ID의 사용자가 존재하지 않는 경우
*/
public User findUserById(Long userId) throws UserNotFoundException {
// ...
}
3. 나쁜 주석
대다수 주석이 이 범주에 속한다. 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
3.1 주절거리는 주석
특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다.
// Bad
public void loadProperties() {
try {
String propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE;
FileInputStream propertiesStream = new FileInputStream(propertiesPath);
loadedProperties.load(propertiesStream);
} catch (IOException e) {
// 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
}
}
catch 블록에 있는 주석은 저자에게야 의미가 있겠지만 다른 사람들에게는 전해지지 않는다.
3.2 같은 이야기를 중복하는 주석
주석이 코드의 내용을 그대로 중복한다면 코드보다 주석을 읽는 시간이 더 오래 걸린다.
// Bad - 중복 주석
// this.closed가 true일 때 반환되는 유틸리티 메서드다.
// 타임아웃에 도달하면 예외를 던진다.
public synchronized void waitForClose(final long timeoutMillis) throws Exception {
if (!closed) {
wait(timeoutMillis);
if (!closed) {
throw new Exception("MockResponseSender could not be closed");
}
}
}
3.3 오해할 여지가 있는 주석
주석이 코드와 살짝 다른 정보를 제공하면 다른 프로그래머가 주석을 믿고 함수를 호출해 디버깅에 시간을 낭비할 수 있다.
3.4 의무적으로 다는 주석
모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석다.
// Bad - 의무적인 주석
/**
* @param title CD 제목
* @param author CD 저자
* @param tracks CD 트랙 숫자
* @param durationInMinutes CD 길이(분 단위)
*/
public void addCD(String title, String author, int tracks, int durationInMinutes) {
CD cd = new CD();
cd.title = title;
cd.author = author;
cd.tracks = tracks;
cd.duration = durationInMinutes;
cdList.add(cd);
}
3.5 이력을 기록하는 주석
예전에는 소스 코드 관리 시스템이 없었으므로 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 있었다. 하지만 이제는 소스 코드 관리 시스템이 있으니 완전히 제거하는 편이 좋다.
// Bad - 이력 주석
/**
* 변경 이력 (11-Oct-2001부터)
* --------------------------
* 11-Oct-2001: 클래스를 정리하고 새로운 패키지로 옮김
* 05-Nov-2001: getDescription() 메서드 추가
* ...
*/
3.6 있으나 마나 한 주석
너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
// Bad
/**
* 기본 생성자
*/
protected AnnualDateRule() { }
/** 월 중 일자 */
private int dayOfMonth;
3.7 무서운 잡음
때로는 Javadocs도 잡음이다. 단지 문서를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음이다.
3.8 함수나 변수로 표현할 수 있다면 주석을 달지 마라
// Bad
// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))
// Good
ArrayList<Module> moduleDependencies = smodule.getDependSubsystems();
String ourSubSystem = subSysMod.getSubSystem();
if (moduleDependencies.contains(ourSubSystem))
3.9 위치를 표시하는 주석
소스 파일에서 특정 위치를 표시하려 주석을 사용하는 경우가 있다. 너무 자주 사용하지 않는다면 배너는 눈에 띄며 주의를 환기한다. 그러므로 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.
// Bad - 과도한 배너
// Actions //////////////////////////////////
3.10 닫는 괄호에 다는 주석
닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.
// Bad
public class Test {
public static void main(String[] args) {
try {
while (...) {
// ...
} // while
} // try
catch (Exception e) {
// ...
} // catch
} // main
}
3.11 공로를 돌리거나 저자를 표시하는 주석
소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다. 저자 이름으로 코드를 오염시킬 필요가 없다.
// Bad
/* 릭이 추가함 */
3.12 주석으로 처리한 코드
주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고 생각하기 때문이다. 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 그냥 삭제하라.
// Bad
InputStreamResponse response = new InputStreamResponse();
response.setBody(formatter.getResultStream(), formatter.getByteCount());
// InputStream resultsStream = formatter.getResultStream();
// StreamReader reader = new StreamReader(resultsStream);
// response.setContent(reader.read(formatter.getByteCount()));
3.13 HTML 주석
소스 코드에서 HTML 주석은 혐오 그 자체다. Javadocs와 같은 도구로 주석을 뽑아 웹 페이지에 올려야 한다면 주석에 HTML 태그를 삽입하는 책임은 프로그래머가 아니라 도구가 져야 한다.
3.14 전역 정보
주석을 달아야 한다면 근처에 있는 코드만 기술하라. 시스템의 전반적인 정보를 기술하지 마라.
3.15 너무 많은 정보
주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
3.16 모호한 관계
주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
// Bad
/*
* 모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에
* 필터 바이트를 더한다). 그리고 헤더 정보를 위해 200바이트를 더한다.
*/
this.pngBytes = new byte[((this.width + 1) * this.height * 3) + 200];
필터 바이트란 무엇일까? +1과 관련이 있을까? *3과 관련이 있을까? 아니면 둘 다? 주석 자체가 다시 설명을 요구한다.
4. 결론
주석은 나쁜 코드를 보완하지 못한다. 코드로 의도를 표현하라!
주석을 달아야 한다면:
- 정말로 좋은 주석인지 생각하라
- 코드로 표현할 방법은 없는지 고민하라
- 주석을 유지보수할 각오가 되어 있는지 확인하라
코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요 없는 방향으로 에너지를 쏟자.
Comments