[4장] 주석
잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 전혀 필요하지 않다. 주석은 오래될수록 유지하고 보수하기 어려워서 그릇될 가능성도 커진다.
저자는 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 주석이 애초에 필요없는 방향으로 에너지를 쏟겠다고 한다. 우리는 주석을 가능한 줄이도록 꾸준히 노력해야한다.
주석은 나쁜 코드를 보완하지 못한다.
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는데 시간을 보내라!
코드로 의도를 표현하라!
많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.
나쁜코드
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))
좋은코드
if (employee.isEligibleForFullBebefits())
좋은 주석
좋은 주석은 필요하거나 유익하다. 지금부터 글자 값을 한다고 생각하는 주석을 소개한다.
법적인 주석
각 소스파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보 등 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣는 것은 타당하다.
// Copyright (C) 2003, 2004, 2005 by Object Montor, Inc. All right reserved.
// GNU General Public License
정보를 제공하는 주석
기본적인 정보를 주석으로 제공하면 편리하다.
// 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();
}
의미를 명료하게 밝히는 주석
모호한 인수나 반환값을 읽기 좋게 표현하면 더 좋았겠지만 표준 라이브러리나 변경하지 못하는 코드일 경우, 의미를 명료하게 밝히는 주석이 유용하다.
assertTrue(a.compareTo(a)==0); //a==a
assertTrue(a.compareTo(b)!=0); //a!=a
assertTrue(a.compareTo(ab)==0); //ab==ab
결과를 경고하는 주석
다른 프로그래머에게 결과를 경고하는 목적으로 사용하는 주석
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile() {
...
}
TODO 주석
앞으로의 할일을 주석으로 남겨두면 편하다. TODO로 떡칠한 코드가 되지 않게 주의할 것.
// TODO-MdM 현재 필요하지 않다.
// 체크아웃 모델을 도입하면 함수가 필요 없다.
protected VersionInfo makeVersion() throws Exception {
return null;
}
중요성을 강조하는 주석
대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용
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를 작성한다. 하지만 다른 주석과 마찬가지로 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재한다.
나쁜 주석
대다수의 코드가 이 범쥐에 속한다.
주절거리는 주석
특별한 이유 없이 의무감으로, 프로세스에서 하라고 해서 마지못해 주석을 단다면 시간낭비이다. 주석을 달기로 결정했다면 충분한 시간을 들여 좋은 주석을 달도록 한다.
public void loadProperties() {
try {
String propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE;
FileInputStream propertiesStream = new FileInputStream(propertiesPath);
loadedProperties.load(propertiesStream);
} catch (IOException e) {
// 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
}
}
- 위 주석은 저자에게나 의미가 있고 다른 프로그래머에게 전달되지 않는다.
- 이것을 이해하려면 다른 코드를 뒤져봐야 알 수 있다. 그러한 주석은 바이트만 낭비할 뿐이다.
같은 이야기를 중복하는 주석
헤더에 달린 주석이 같은 코드 내용을 그대로 중복한다.
// 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");
}
}
}
오해할 여지가 있는 주석
바로 위의 코드는 오해의 여지가 있다. 위에 closed는 무조건 true가 변하는 순간에 예외를 던지는 것이 아니다. closed가 true가 아니면 타임아웃을 기다렸다가 closed 가 true인지 확인하고 그래도 아니면 예외를 던진다.
주석을 잘못 읽었다가 closed가 true로 변하면 반환된다고 생각할 수도 있다.
의무적으로 다는 주석
모든 Javadocs를 달거나 모든 변수에 주석을 달아야하는 규칙은 어리석다. 오히려 잘못된 정보를 제공할 여지만 만든다.
이력을 기록하는 주석
예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 것이 바람직했다. 하지만 소스 관리 시스템이 발전되면서 이력을 기록하는 주석은 혼란만 가중할 뿐이다.
* 변경 이력 (11-Oct-2001부터)
* ------------------------------------------------
* 11-Oct-2001 : 클래스를 다시 정리하고 새로운 패키지인 com.jrefinary.date로 옮겼다.
* 05-Nov-2001: getDescription() 메소드 추가했으며 NotableDate class를 제거했다.
...
있으나 마나한 주석
너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
/**
* 기본 생성자
*/
protected AnnaualDateRule() {}
// 월 중 일자
private int dayOfMonth;
/**
* 월 중 일자를 반환한다.
* @return 월 중 일자
*/
public int getDayOfMonth() {
return dayOfMonth;
}
함수나 변수로 표현할 수 있다면 주석을 달지마라
나쁜 코드
//전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))
좋은 코드
ArrayList moduleDependees = smodule.getDependSubsystems();
String ourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))
위치를 표시하는 주석
때로는 소스파일에서 특정 위치를 표시하려 주석을 사용한다.
// Actions ///////////////////////
위와 같은 주석은 가독성을 낮추므로 제거해야 마땅하다. 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.
닫는 괄호에 다는 주석
중첩이 심하고 장황한 함수라면 의미가 있겠지만 작고 캡슐화된 함수에는 잡음이다. 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 함수를 줄이려 시도하자.
공로를 돌리거나 저자를 표시하는 주석
/*릭이 추가함*/
마찬가지로 소스 코드 관리 시스템이 귀신처럼 기억한다. 굳이 주석으로 코드를 오염시킬 필요가 없다.
주석으로 처리한 코드
주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있고, 중요하다고 생각한다. 과감하게 지우자. 코드 잃어버릴 염려는 없다. 소스 코드 관리 시스템이 기억해준다.
HTML 주석
HTML주석은 IDE에서도 읽기 힘들다. 사용하지말자
전역 정보 주석
주석을 달아야 한다면 근처에 있는 코드에만 주석을 달자. 코드 일부에 주석을 달면서 시스템 전반에 대한 정보를 적지 말자.
너무 많은 정보
주석에다가 흥미로운 역사나 관련없는 정보를 장황하게 늘어놓지 마라.
모호한 관계를 나타내는 주석
주석과 주석이 설명 하는 코드는 둘 사이 관계가 명확해야 한다. 이왕 공들어 주석을 썼다면 정확하게 설명하려고 하자.
비공개 코드에서 Javadocs
공개 API 에서는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.
시스템 내부에 속한 클래스와 함수에 Javadocs를 생성할 필요는 없다. 유용하지 않고 Javadocs 형식으로 인해 코드만 보기 싫어진다.
Reference
- 클린코드 , 로버트C. 마틴
Leave a comment