[Clean Code] 4장 주석

나쁜 코드에 주석을 달지 마라 새로 짜라 -브라이언 W.커니핸, P.J.플라우거

​

잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.

주석은 쉰들러 리스트가 아니다. 주석은 '순수하게 선하지' 못하다. 사실상 주석은 기껏해야 필요악이다. 프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면 주석은 필요하지 않다.

우리는 코드로 의도를 표현하지 못한다. 그래서 실패를 만회하기 위해 주석을 사용한다.

그러므로 주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다. 주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다.

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.

---

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

---

코드로 의도를 표현하라!

확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다.

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

if (employee.isEligibleForFullBenefits())

몇 초만 더 생각하면 대다수 의도를 표현할 수 있다. 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

---

좋은 주석

어떤 주석은 그럼에도 필요하거나 유익하다. 하지만 그럼에도 명심하자 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실!

​

법적인 주석

때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.

// Copyright (C) 2003,2004,2005 by Object Mentor, Inc. All rights reserved.
// GNU General Public License 버전 2 이상을 따르는 조건으로 배포한다.

정보를 제공하는 주석

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

// 테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance();

가능하다면 함수 이름에 정보를 담는 편이 더 좋다.

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

위제 제시한 주석은 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명한다. 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔하겠다.

​

의도를 설명하는 주석

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

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; // 오른쪽 유형이므로 정렬 순위가 더 높다.
}

public void testConcurrentAddWidgets() throws Exception {
 WidgetBuilder widgetBuilder =
 new WidgetBuilder(new Class[]{BoldWidget.class});
 String text = "'''bold text'''";
 ParentWidget parent =
 new BoldWidget(new MockWidgetRoot(), "'''bold text'''");
 AtomicBoolean failFlag = new AtomicBoolean();
 failFlag.set(false);
 // 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
 for (int i = 0; i < 25000; i++) {
 WidgetBuilderThread widgetBuilderThread =
 new WidgetBuilderThread(widgetBuilder, text, parent, failFlag);
 Thread thread = new Thread(widgetBuilderThread);
 thread.start();
 }
 assertEquals(false, failFlag.get());
}

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

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

public void testCompareTo() throws Exception
{
 WikiPagePath a = PathParser.parse("PageA");
 WikiPagePath ab = PathParser.parse("PageA.PageB");
 WikiPagePath b = PathParser.parse("PageB");
 WikiPagePath aa = PathParser.parse("PageA.PageA");
 WikiPagePath bb = PathParser.parse("PageB.PageB");
 WikiPagePath ba = PathParser.parse("PageB.PageA");
 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
 assertTrue(b.compareTo(a) == 1); // b > a
 assertTrue(ab.compareTo(aa) == 1); // ab > aa
 assertTrue(bb.compareTo(ba) == 1); // bb > ba
}

그릇된 주석을 달아놓을 위험은 상당히 높다!!!

​

결과를 경고하는 주석

때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.

// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile()
{
 writeLinesToFile(10000000);
 response.setBody(testFile);
 response.readyToSend(this);
 String responseString = output.toString();
 assertSubString("Content-Length: 1000000000", responseString);
 assertTrue(bytesSent > 1000000000);
}

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()));

---

나쁜 주석

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

​

주절거리는 주석

주석을 달기로 결정했으면 충분한 시간을 들여 최고의 주석을 단다.

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");
 }
}

오해할 여지가 있는 주석

때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다. 살짝 잘못된 정보로 인해 잘못된 함수를 사용해서 잘못된 값이 반환되기도 한다.

​

의무적으로 다는 주석

모든 함수에 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 : 클래스를 다시 정리하고 새로운 패키지인
 * com.jrefinery.date로 옮겼다 (DG);
 * 05-Nov-2001 : getDescription() 메서드를 추가했으며
 * NotableDate class를 제거했다 (DG);
 * 12-Nov-2001 : IBD가 setDescription() 메서드를 요구한다. NotableDate
 * 클래스를 없앴다 (DG); getPreviousDayOfWeek(),
 * getFollowingDayOfWeek(), getNearestDayOfWeek()를 변경해
 * 버그를 수정했다 (DG);
 * 05-Dec-2001 : SpreadsheetDate 클래스에 존재하는 버그를 수정했다 (DG);
 * 29-May-2002 : month 상수를 독자적인 인터페이스로 옮겼다
 * (MonthConstants) (DG);
 * 27-Aug-2002 : addMonths() 메서드에 있는 버그를 수정했다. N???levka Petr 덕분이다 (DG);
 * 03-Oct-2002 : Checkstyle이 보고한 오류를 수정했다 (DG);
 * 13-Mar-2003 : Serializable을 구현했다 (DG);
 * 29-May-2003 : addMonths 메서드에 있는 버그를 수정했다 (DG);
 * 04-Sep-2003 : Comparable을 구현했다. isInRange Javadocs를 갱신했다 (DG);
 * 05-Jan-2005 : addYears() 메서드에 있는 버그를 수정했다 (1096282) (DG);

혼란만 가중된다.

​

있으나 마나 한 주석

너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.

/**
 * 기본 생성자
 */
protected AnnualDateRule() {
}

/** 월 중 일자 */
 private int dayOfMonth;

무서운 잡음

public class wc {
public static void main(String[] args) {
 BufferedReader in = new BufferedReader(new InputStreamReader(System.in));
 String line;
 int lineCount = 0;
 int charCount = 0;
 int wordCount = 0;
 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
catch (IOException e) {
 System.err.println("Error:" + e.getMessage());
 } //catch
} //main
}

때로는 javadocs도 잡음이다.

/** The name. */
private String name;
/** The version. */
private String version;
/** The licenceName. */
private String licenceName;
/** The version. */
private String info;

단지 문서를 작성하기 위한 주석이다. 함수나 변수로 표현할 수 있다면 주석을 달지 마라.

​

위치를 표시하는 주석

소스 파일에서 특정 위치를 표시하려 주석을 사용한다.

​

닫는 괄호에 다는 주석

닫는 괄호는 작고 캡슐화된 함수에는 잡음일 뿐이다. 그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.

public class wc {
public static void main(String[] args) {
 BufferedReader in = new BufferedReader(new InputStreamReader(System.in));
 String line;
 int lineCount = 0;
 int charCount = 0;
 int wordCount = 0;
 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
catch (IOException e) {
 System.err.println("Error:" + e.getMessage());
 } //catch
} //main
}

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

소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다. 저자 이름으로 코드를 오염시킬 필요가 없다.

​

주석으로 처리한 코드

주석으로 처리한 코드만큼 이상한 코드도 없다.

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()));

꼭 이유가 있어서 남겨놓은것 같지만 아니다.!

​

HTML 주석

소스 코드에서 HTML 주석은 혐오 그 자체다. 다음 코드를 읽어보면 무슨 말인지 알리라.

/**
 * 적합성 테스트를 수행하기 위한 과업
 * 이 과업은 적합성 테스트를 수행해 결과를 출력한다.
 * <p/>
 * <pre>
 * 용법:
 * &lt;taskdef name=&quot;execute-fitnesse-tests&quot;
 * classname=&quot;fitnesse.ant.ExecuteFitnesseTestsTask&quot;
 * classpathref=&quot;classpath&quot; /&gt;
 * 또는
 * &lt;taskdef classpathref=&quot;classpath&quot;
 * resource=&quot;tasks.properties&quot; /&gt;
 * <p/>
 * &lt;execute-fitnesse-tests
 * suitepage=&quot;FitNesse.SuiteAcceptanceTests&quot;
 * fitnesseport=&quot;8082&quot;
 * resultsdir=&quot;${results.dir}&quot;
 * resultshtmlpage=&quot;fit-results.html&quot;
 * classpathref=&quot;classpath&quot; /&gt;
 * </pre>
 */

전역 정보

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

/**
 * 적합성 테스트가 동작하는 포트: 기본값은 <b>8082</b>.
 *
 * @param fitnessePort
 */
public void setFitnessePort(int fitnessePort)
{
 this.fitnessePort = fitnessePort;
}

너무 많은 정보

주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.

/*
 RFC 2045 - Multipurpose Internet Mail Extensions (MIME)
 1부: 인터넷 메시지 본체 형식
 6.8절. Base64 내용 전송 인코딩(Content-Transfer-Encoding)
인코딩 과정은 입력 비트 중 24비트 그룹을 인코딩된 4글자로 구성된
출력 문자열로 표현한다. 왼쪽에서 오른쪽으로 진행해가며, 3개를 묶어 8비트 입력
그룹을 형성한다. 이렇게 만들어진 24비트는 4개를 묶어 6비트 그룹으로 취급하며,
각각은 base64 알파벳에서 단일 자릿수로 해석된다.
 base64 인코딩으로 비트 스트림을 인코딩할 때, 비트 스트림은
 MSB(Most Significant Bit) 우선으로 정렬되어 있다고 가정한다. 따라서, 스트림에서
첫 번째 비트는 첫 8비트 바이트에서 최상위 비트가 되며, 여덟번째 비트는 첫 8비트
바이트에서 최하위 비트가 된다.
*/

모호한 관계

주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. 이왕 공들여 주석을 달았다면 적어도 독자가 주석과 코드를 읽어보고 무슨 소린지 알아야한다.

/*
 * 모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다).
 * 그리고 헤더 정보를 위해 200바이트를 더한다.
 */
this.pngBytes = new byte[((this.width + 1) * this.height * 3) + 200];

함수 헤더

짧은 함수는 긴 설명이 필요 없다.짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.