4장. 주석
나쁜 코드에 주석을 달지 마라. 새로 짜라.
-브라이언 W.커니핸, P.J.플라우거
주석은 필요악이다.
코드로 의도를 표현하지 못해, 실패를 만회하기 위해 쓰는 것이다.
주석은 언제나 실패를 의미한다.
주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다.
그래서 주석은 반겨 맞을 손님이 아니다.
주섯이 필요한 상황에 처하면, 코드로 의도를 표현할 방법이 없을지 곰곰이 생각하기 바란다.
주석은 항상도 아니고 고의도 아니지만, 주석이 오래될수록 코드에서 멀어져서 거짓말을 하게 될 가능성이 커진다.
코드는 유지보수를 해도, 주석을 계속 유지보수하기란 현실적으로 불가능하기 때문이다.
부정확한 주석은 아예 없는 주석 보다 훨씬 나쁘다.
주석은 나쁜 코드를 보완하지 못한다
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나빠서이다.
깔끔하고 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!
코드를 의도로 표현하라!
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((emplotee.flags & HOURLY_FLAG) && (employee.age > 65)다음 코드는 어떤가?
if (employee.isEligibleForFullBenefits())
주석도 필요없이 함수 이름만으로 충분히 깔끔하게 표현되었다.
좋은 주석
법적인 주석
각 소스 파일 첫머리에 들어가는 저작권 정보와 소유권 정보 등
// Copyright (C) 2003, 2004, 2005 by Object Montor, Inc. All right reserved.
// GNU General Public License
정보를 제공하는 주석
// 테스트 중인 Responder 인스턴스를 반환
protected abstract Responder responderInstance();물론 이 주석도 함수 이름에 정보를 담아 responderBeingTested로 바꾸면 없앨 수 있다.
더 나은 예:
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile(
"\\d*:\\d*\\d* \\w*, \\w*, \\d*, \\d*");의도를 설명하는 주석
...
// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
for (int i = 0; i > 2500; i++) {
WidgetBuilderThread widgetBuilderThread =
new WidgetBuilderThread(widgetBuilder, text, parent, failFlag);
Thread thread = new Thread(widgetBuilderThread);
thread.start();
}
...결과를 경고하는 주석
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile() {
...
}물론 최근에는 @Ignore("실행이 너무 오래 걸린다.") 애노테이션을 이용해서 표현할 수도 있다.
TODO 주석
// TODO-MdM 현재 필요하지 않다.
// 체크아웃 모델을 도입하면 함수가 필요 없다.
protected VersionInfo makeVersion() throws Exception {
return null;
}TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
더 이상 필요 없는 기능을 삭제하라는 알림,
누군가에게 문제를 봐달라는 요청,
더 좋은 이름을 떠올려달라는 부탁,
앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의
등에 유용하다.
요즘은 IDE를 통해 남은 TODO를 쉽게 볼 수 있으므로 편리하게 이용할 수 있다.
중요성을 강조하는 주석
String listItemContent = match.group(3).trim();
// 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.
// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.
new ListItemWidget(this, listItemContent, this.level + 1);
return buildList(text.substring(match.end()));공개 API에서 Javadocs
설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다.
공개 API를 구현한다면 반드시 훌륭한 Javadocs 작성을 추천한다.
하지만 여느 주석과 마찬가지로 Javadocs 역시
독자를 오도하거나,
잘못 위치하거나,
그릇된 정보를 전달할 가능성이 존재하는 것 역시 잊으면 안 된다.
나쁜 주석
대다수의 주석이 이 범주에 속한다.
일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등
프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
주절거리는 주석
특별한 이유 없이 달리는 주석이다.
public void loadProperties() {
try {
String propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE;
FileInputStream propertiesStream = new FileInputStream(propertiesPath);
loadedProperties.load(propertiesStream);
} catch (IOException e) {
// 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
}
}catch 블록에 있는 주석은 저자에게야 의미가 있겠지만 다른 사람들에게는 전해지지 않는다.
저 주석의 의미를 알아내려면 다른 코드를 뒤져보는 수밖에 없다.
이해가 안되서 다른 모듈까지 뒤져야 하는 주석은 제대로 된 주석이 아니다.
같은 이야기를 중복하는 주석
코드 내용을 그대로 중복하는 주석
// 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");
}
}
}오해할 여지가 있는 주석
위의 코드는 중복이 많으면서도 오해할 여지가 살짝 있다.
this.closed가 true로 변하는 순간에 메서드는 반환되지 않고, this.closed가 true여야 메서드는 반환된다.
아니면 무조건 타임아웃을 기다렸다 this.closed가 그래도 true가 아니면 예외를 던진다.
주석에 담긴 '살짝 잘못된 정보' 로 인해 어느 프로그래머가 경솔하게 함수를 호출해 자기 코드가 아주 느려진 이유를 못찾게 되는 것이다.
의무적으로 다는 주석
모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.
이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.
아래와 같은 주석은 아무 가치도 없다.
/**
*
* @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);
}이력을 기록하는 주석
지금은 소스 코드 관리 시스템이 있으니 전혀 필요없다.
* 변경 이력 (11-Oct-2001부터)
* ------------------------------------------------
* 11-Oct-2001 : 클래스를 다시 정리하고 새로운 패키징
* 05-Nov-2001: getDescription() 메소드 추가
* 이하 생략있으나 마나 한 주석
너무 당연한 사실을 언급하며 새로운 정보를 제공하는 주석.
/*
* 기본 생성자
*/
protected AnnualDateRule() {
}위의 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠져 자동으로 주석을 건너뛰게 만들수있다.
있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라
함수나 변수로 표현할 수 있다면 주석을 달지 마라
// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (module.getDependSubsystems().contains(subSysMod.getSubSystem()))주석을 제거하고 다시 표현하면 다음과 같다.
ArrayList moduleDependencies = smodule.getDependSubSystems();
String ourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))주석을 먼저 달고 주석에 맞춰 코드를 작성한 느낌이다.
함수를 통해 무슨 일을 하는지 설명하고, 변수를 통해 이 변수가 어떤 의도로 값을 저장하는지를 나타낼 수 있다면 주석은 불필요하다.
위치를 표시하는 주석
때때로 프로그래머는 소스 파일에서 특정 위치를 표시하려 주석을 사용한다.
예를 들어
// Actions /////////////////////////////////////////////이런 주석은 가독성만 낮추므로 제거해야 마땅하다.
특히 뒷부분에 슬래시로 이어지는 잡음은 제거하는 편이 좋다.
너무 자주 사용하지 않을때만 배너는 눈에 띄며 주위를 환기한다.
그러므로 반드시 필요할 때 아주 드몰게 사용하는 편이 좋다.
닫는 괄호에 다는 주석
중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화면 함수에는 잡음일 뿐이다.
그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.
공로를 돌리거나 저자를 표시하는 주석
/* 릭이 추가함 */소스코드 관리시스템에 저장하자
주석으로 처리한 코드
주석으로 처리된 코드는 남겨진 이유가 있다 생각해서 다른사람들이 지우기를 주저하기에 쓸모 없는 코드가 점차 쌓여간다.
this.bytePos = writeBytes(pngIdBytes, 0);
//hdrPos = bytePos;
writeHeader();
writeResolution();
//dataPos = bytePos;
if (writeImageData()) {
wirteEnd();
this.pngBytes = resizeByteArray(this.pngBytes, this.maxPos);
} else {
this.pngBytes = null;
}
return this.pngBytes;1960년대 즈음에는 주석으로 처리한 코드가 유용했었지만 우리는 우수한 소스 코드 관리 시스템을 사용하기 때문에 우리를 대신에 코드를 기억해준다. 그냥 삭제하라. 잃어버릴 염려는 없다.
HTML 주석
소스코드에서 HTML주석은 혐오 그자체다.
HTML주석은 (주석을 읽기 쉬워야 하는) 편집기/IDE에서조차 읽기가 어렵다.
전역 정보
주석을 달아야 한다면 근처에 있는 코드만 기술하라.
코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
해당 시스템의 코드가 변해도 아래 주석이 변하리라는 보장은 전혀 없다.
그리고 심하게 중복된 주석도 확인하자.
/**
* 적합성 테스트가 동작하는 포트: 기본값은 <b>8082</b>.
*
* @param fitnessePort
*/
public void setFitnessePort(int fitnessePort) {
this.fitnewssePort = fitnessePort;
}너무 많은 정보
이 코드가 왜 이렇게 되었는 지에 대한 과거 배경을 설명한다던가, 불필요할정도로 자세한 정보를 작성할 필요는 없다.
모호한 관계
주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
- 주석에서 의도는 한 부분만 설명하는데, 코드에서 여러 부분을 동시에 처리하는 경우
- 수식이 복잡한데 의도만 설명해서 해당 수식을 이해하기 힘든 경우
함수 헤더
짧은 함수는 긴 설명이 필요없다.
짧고 한가지만 수행하며 함수 이름만 잘 선택해도 주석이 불필요하다.
비공개 코드에서 Javadocs
공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.
코드만 보기싫고 산만해질 뿐이다.
나의 생각
이 장을 읽기전에는 '주석을 잘 다는 법' 에 대한 내용이 있을거란 기대가 컸다.
내가 써왔던 주석은 너무 조잡하다 생각했기 때문이다.
하지만 뒷통수를 쎄게 맞은 느낌이었다.
코드자체가 의도를 정확하게 표현하지 못해서 추가로 주석을이용해 설명하려한다는말이 너무나도 딱 맞아떨어졌기 때문이다.
나의 주석중 일부는 이 코드는 왜 작성했고, 어떤기능을하는지 등이었고,
그런 정보들이아니라면 정말 의미 없는 주석이었다.
또, 코드의 변화에 맞춰 주석도 같이 변화했었나....라는 생각이 머리에 박혔다.
코드가 너무 복잡해서, 모호해서, 불분명해서 주석을 고민하지말고
함수를 쪼개고 분명한 의미를 가질 수 있도록 코드를 개선해야겠다.
