이 글에서는 로버트 C. 마틴의 저서인 클린 코드 중 4장 주석(comments)에 대해서 설명합니다.
- 4장 주석(comments) 정리
- 코드에서 주석을 제거하는 예제
4장 주석(Comments) 정리
이번 장 학습에는 내용을 읽으면서 제 의견을 중간중간에 아주 미미하게 삽입 하였습니다. 참고하시기 바랍니다.
들어가면서
나쁜 코드에 주석을 달지 마라. 새로 짜라.
-브라이언 W. 커니핸, P. J. 플라우거
- 잘 달린 주석은 유용하고, 경솔하고 근거 없는 주석은 이해를 어렵게 만들며, 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미칠 수 있다.
- 주석은 순수하게 선하지 못하며, 코드로 의도를 표현하지 못해 실패를 만회하기 위해 사용한다.
- 주석은 유지보수가 잘 되지 않으며, 잘못된 정보를 전달하는 경우가 많다. 언제나 진실은 코드에 있다.
- 주석을 달 때마다 자신에게 표현력이 없다는 사실을 인지하고, 코드로 의도를 표현할 방법을 고민하는 것이 좋다.
- 부정확한 주석은 전혀 없는 주석보다 더 나쁘며, 프로그래머는 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로 주석을 최소화해야 한다.
코드로 의도를 표현하라!
아래의 주석이 있는 코드와 주석이 없는 코드 중 어떤 코드가 더 나은가?
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다. if((employee. flags & HOURLY_FLAG) && (employee.age>65)) VS if (employee.isEligibleForFullBenefits())
좋은 주석/법적인 주석/ 정보를 제공하는 주석
- 좋은 주석은 주석을 달지 않을 방법을 찾아내는 것이 좋다.
- 법적인 주석은 회사가 정립한 구현 표준에 맞춰 넣는 것이 필요하다.
- 함수 이름에 정보를 담는 것이 가능하면 주석 대신 사용하는 것이 좋다.
- 주석이 어떤 의미를 담는다면 클래스로 만들어 코드로 옮기면 주석이 필요 없다.
의도를 설명하는 주석
public int compareTo(Object o)
{
if(o instanceof WikiPagePath)
{
WikipagePath p= (WikiPagePath) 0;
String compressedName = StringUtil.join(names, "");
String compressedArgumentName = StringUtil.join(p.names, "");
return compressedName. compareTo(compressedArgumentName);
}
return 1; // 오른쪽 유형이므로 정렬 순위가 더 높다.
} 의미를 명료하게 밝히는 주석
때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다. 일반적으로는 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
하지만, 잘못된 주석을 달아놓을 위험이 상당히 크며, 주석이 올바른지 검증하기가 어렵다. 그러므로, 주석이 반드시 필요한지 다른 대안이 없는지 각별히 주의해야한다.
결과를 경고하는 주석
다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용하기도 한다.
아래와 같은 주석은 합리적인 주석이다. 프로그램 효율화를 위해 정적 초기화 함수를 사용하려던 프로그래머가 주석 때문에 실수를 면할 수 있다.
public static SimpleDateFormat makeStandardHttpDateFormat()
{
// SimpleDateFormat은 스레드에 안전하지 못하다.
// 따라서 각 인스턴스를 독립적으로 생성해야 한다.
SimpleDateFormat df = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z"); df.setTimeZone(TimeZone.getTimeZone("GMT"));
return df;
} TODO 주석
TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
하지만, 시간이 지나도 구현되지 않는 TODO는 코드를 어지럽힐 수 있다. 그러므로 TODO 주석은 주기적으로 점검해서 없애는 것이 좋다.
중요성을 강조하는 주석
String listItemContent = match.group(3).trim(); // 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다. // 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다. new ListItemWidget(this, listItemContent, this. level + 1); return buildList(text.substring(match.end()));
나쁜 주석
주절거리는 주석
특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석
을 단다면 전적으로 시간낭비다. 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.
이해가 안 되어 다른 모둘까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트만 낭비할 뿐이다.
같은 이야기를 중복하는 주석
아래 주석은 코드와 동일한 내용을 그대로 적어 놓은 경우인데, 만약 주석이 잘못되었다면 코드를 보는 프로그래머에게 잘못된 정보만 전달한다. 일반적으로 프로그래머는 눈에 들어오는 주석을 먼저 보는 경향이 있다.
// 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가 아니면 예외를 던진다.
그러므로, 이 함수를 호출하는 개발자는 주석만을 보고 다른 스레드로 closed로 변경해 주었지만 반환되지 않고 대기하고 있어서 원인을 찾느라 한참을 헤멜 수도 있다.
의무적으로 다는 주석
모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다. 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.
이력을 기록하는 주석
때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가한다. 그리하여 모듈 첫머리 주석은 지금까지 모듈에 가한 변경을 모두 기록하는 일종의 일지 혹은 로그가 된다. 첫머리 주석만 십여 쪽을 넘어서는 모듈도 보았다.
* 03-Oct-2002: Checkstyle이 보고한 오류를 수정했다 (DG); * 13-Mar-2003: Serializable을 구현했다 (DG); * 29-May-2003: addMonths 메서드에 있는 버그를 수정했다 (DG); * 04-Sep-2003 : Comparable을 구현했다. isInRange Javadocs를 갱신했다 (DG);
이런 류의 주석은 소스코드 관리 시스템이 있기 전에 유용한 형식이다. 지금은 완전히 제거하고 소스코드 관리 시스템에 커밋 로그를 잘 남기는 것이 훨씬 유용한다.
있으나 마나 한 주석
너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
/**
*기본 생성자
*/
protected AnnualDateRule() {
} 무서운 잡음
때로는 Javadocs도 잡음이다. 다음은 잘 알려진 오픈 소스 라이브러리에서 가져온 코드다.
/** The name. */ private String name; /** The version. */ private String version; /** The licenceName. */ private String licenceName; /** The version. */ private String info;
주석은 아무 의미를 전달하지 못할 뿐 아니라 주석을 달아야 한다는 잘못된 욕심으로 주석의 오류가 발생했다. 이는 코드만 더럽히는 꼴이다.
함수나 변수로 표현할 수 있다면 주석을 달지 마라
함수나 변수로 표현 가능하다면 주석을 달지 않아야 한다. 함수나 변수로 표현하면 되니까.
위치를 표시하는 주석
// Actions ////////////////////////////
위와 같은 형태로 주석을 남기고 그 아래에 실제 Actions에 해당하는 함수들을 넣어 놓는 경우가 종종 있다. 하지만, 관리가 안되면 가독성만 낮추는 결과를 가져올 수 있으므로 주의해서 사용해야한다.
닫는 괄호에 다는 주석
아래와 같이 닫는 괄호에 주석을 다는 경우를 종종 볼 수 있다. 이런류의 주석은 함수가 길거나 중첩이 심하고 장황한 경우에 주로 발생한다. 그러므로 이런 주석을 다는것 보다는 함수를 줄이거나 개선하는 편이 좋다.
try {
while((line = in.readLine()) != null) {
lineCount++;
charCount += line.length();
String words[] = line.split("\\W'');
wordCount += words.length;
}//while
System.out.println("wordCount = + wordCount);
System.out.println("lineCount = +lineCount);
System.out.println("charCount = + charCount);
}//try 공로를 돌리거나 저자를 표시하는 주석
/* 릭이 추가함 */
위와 같은 내용은 소스코드 관리 시스템으로 인해 아무런 필요가 없다. 오히려 코드만 더럽힐 뿐이다. 때로는, BTS(Bug Tracking System)의 버그 번호를 적어 놓는 경우도 종종 있다. 그러나, 이 경우에도 소스코드 관리 시스템으로 찾아보는 것이 더 유용하다. 해당 주석은 관리가 되지 않을 수 있으며 코드가 변경되면 잘못된 정보를 줄 가능성이 더 높다.
주석으로 처리한 코드
주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각한다. 그래서 더욱더 이런 류의 주석이 쌓여가며 코드를 어지럽히게 된다.
주석으로 처리한 코드는 새로운 아이디어나 더 좋은 방법이라고 생각되지만 호환성 등의 문제로 추가하지 못한 경우에 의미를 남겨 놓으면 미래에 활용할 가치가 있을 수 있다. 그렇지 않는 주석들은 사용하지 않으면서 코드 분석에 어려움을 가중시킨다.
소스코드 시스템이 과거를 기억하기는 하지만 새로 코드를 보고 작성중인 개발자는 좋은 아이디어가 있는 코드가 과거 어느 시점에 있었는지 기억하지 못한다. 그러므로, 개선 아이디어와 같은 경우 주석으로 남겨 놓을 수 있다.
HTML 주석
HTML 주석은 보기 매우 어렵다. 아래의 예시를 살펴보기 바란다. 그러므로 HTML 코드 주석은 제거하는 편이 낫다.
/*... classpathref="classpath" />
* <taskdef classpathref="classpath"
*
*<p/>
resource="tasks.properties" />
* <execute-fitnesse-tests
suitepage="FitNesse. SuiteAcceptanceTests" fitnesseport="8082"
resultsdir="${results.dir}"
resultshtmlpage="fit-results.html"
classpathref="classpath" />
*</pre>
*/전역 정보
너무 많은 정보
주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
모호한 관계
주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
함수 헤더
짧은 함수는 긴 설명이 필요 없다. 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
비공개 코드에서 Javadocs
코드에서 주석을 제거하는 예제
아래 코드를 리팩토링하여 주석을 제거해 보길 바란다. 이 코드는 클린 코드 책에 리팩터링 결과가 기술되어있다.
/*
*이 클래스는 사용자가 지정한 최대 값까지 소수를 생성한다. 사용된 알고리즘은
* 에라스토테네스의 체다.
* <p>
* 에라스토테네스: 기원전 276년에 리비아 키레네에서 출생, 기원전 194년에 사망
*지구 둘레를 최초로 계산한 사람이자 달력에 윤년을 도입한 사람.
*알렉산드리아 도서관장을 역임.
* <p>
*알고리즘은 상당히 단순하다. 2에서 시작하는 정수 배열을 대상으로
* 2의 배수를 모두 제거한다. 다음으로 남은 정수를 찾아 이 정수의 배수를 모두 지운다.
*최대 값의 제곱근이 될 때까지 이를 반복한다.
*eauthor Alphonse
* @version 13 Feb 2002 atp
*/
import java.util.*;
public class GeneratePrimes
{
/**
* @param maxValue는 소수를 찾아낼 최대 값
*/
public static int[] generatePrimes(int maxValue)
{
if (maxValue >= 2) //
{
// 선언
int s = maxValue + 1; //
boolean[] f = new boolean[s];
int i;
// 배열을 참으로 초기화
for (i = 0; i < s; i++)
f[i]
=
true;
// 소수가 아닌 알려진 숫자를 제거
f[0] = f[1] = false;
// 체
int j;
for (i= 2; i < Math.sqrt(s) + 1; i++)
{
if (f[i]) // i가 남아 있는 숫자라면 이 숫자의 배수를 구한다.
{
for (j = 2* i; j < s; j += i)
f[j] = false; // 배수는 소수가 아니다.
}
}
// 소수 개수는?
int count = 0;
for (i = 0; i < s; i++)
{
if (f[i])
count++; //
}
int[] primes = new int[count];
// 소수를 결과 배열로 이동한다.
for (i = 0, j = 0; i < s; i++)
{
if (f[i])
primes[j++] = i;
}
// 소수일 경우에
}
return primes; // 소수를 반환한다.
else // maxValue <2
return new int[0]; // 입력이 잘못되면 비어 있는 배열을 반환한다.
}
} .png)
