[Clean Code] 클린코드 4장 : 주석

클린코드 4장(로버트C. 마틴)을 읽고...

 

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

코드에 주석을 추가하는 이유는 코드의 품질이 나쁘기 때문이다.

표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가

복잡하고 주석이 많이 달린 코드보다 좋다.

(그러니 주석으로 설명하려 하지말고 코드를 정리하는데 시간을 보내자...)

 

코드로 의도를 표현하라

아래 두 코드 예제를 살펴보자

(주석 없이) 확실히 코드만으로 대다수의 의도를 표현할 수 있다.

주석으로 설명하려는 대신 함수로 만들어 표현해도 충분하다.

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

if (employee.isEligibleForFullBenefits())

 

좋은 주석

 

법적인 주석

 

각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.

 

 

정보를 제공하는 주석

 

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

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

하지만 위와 같은 주석도 함수 이름에 정보를 담으면 주석이 필요 없어진다.

protected abstract Responder responderBeingTested();

 

의도를 설명하는 주석

 

때때로 주석은 결정에 깔린 의도까지 설명한다.

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 static SimpleDateFormat makeStandardHttpDateFormat()
{
    //SimpleDateFormat은 스레드에 안전하지 못하다.
    //따라서 각 인스턴스를 독립적으로 생성해야 한다.
    SimpleDateFormat df = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z");
    df.setTimeZone(TimeZone.getTimeZone("GMT"));
    return df;
}

 

중요성을 강조하는 주석

String listItemContent = match.group(3).trim();
// 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.
// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.
new ListItemWidget(this, listItemContent, this.level + 1);
return buildList(text.substring(match.end()));

 

공개 API에서 Javadocs

설명이 잘된 공개 API는 유용하다. 표준 자바 라이브러리에서 사용한 Jacadocs가 좋은 예다.

 

나쁜 주석

 

주절거리는 주석

 

메모리를 읽어 들였다는 뜻이 코드를 보지 않으면 알 수 없다.

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 timeouMillis)
throws Exception
{
    if(!closed)
    {
        wait(timeoutMillis);
        if(!closed)
            throw new Exception("MockResponseSender could not be closed");
    }
}

 

오해할 여지가 있는 주석

 

위 코드에서 this.closed가 true로 변하는 순간이 아니라, true여야 메서드가 반환이 된다.

아니면 무조건 타임아웃을 기다렸다가 this.closed가 그래도 ture가 아니면 예외를 던진다.

이처럼 주석에 담긴 오해할 여지가 있는 주석으로 인하여

어느 프로그래머가 true로 변하는 순간에 함수가 반환될 거라는 생각으로 함수 호출을 할지도 모른다.

 

 

의무적으로 다는 주석

 

/*

param title CD 제목

param author CD저자

*/

와 같은 주석은 아무가치가 없다.

 

 

이력을 기록하는 주석

 

예전에는 모든 모듈 첫머리에 변경 이력을 기록하는 관례가 바람직했으나,

이제는 소스 코드 관리 시스템이 존재하므로 완전히 제거하는 편이 좋다

 

 

있으나 마나 한 주석

 

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

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

//월 중 일자
private int dayOfMonth;

//월 중 일자를 반환한다
public int getDayOfMonth(){
	return dayOfMonth;
}

 

무서운 잡음

 

때로는 Javadocs도 잡음이다.

 

 

함수나 변수로 표현할 수있다면 주석을 달지 마라

//전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (smodule.getDependSubsystmes().contains(subSysMod.getSubSystems()))

ArrayList moduleDependees = smodule.getDependSubsystems();
String ourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))

 

 

위치를 표시하는 주석

 

// Action ///////////////// 과 같이

배너 아래 특정 기능을 모아놓으면 유용한 경우도 있긴 있다.

하지만 일반적으로 위와 같은 주석은 가독성을 낮춘다.

(너무 자주 사용하지 않는다면 배너는 눈에 띄며 주의를 환기하므로 아주 드물게 사용하자.) 

 

 

닫는 괄호에 다는 주석

 

중첩이 심하고 장황한 함수라면 닫는 괄호에 //while //try 와 같은 주석은 의미가 있을 지 모르겠지만

작고 캡슐화된 함수에는 잡음이다.

닫는 괄호에 주석을 달지 말고 함수를 줄이려 시도하자.

 

 

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

 

소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다.

저자 이름으로 코드를 오염시키지 말자.

 

 

주석으로 처리한 코드

 

주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. (이유가 있어서 남겨놓았으리라 생각하므로)

 

 

HTML 주석

 

HTML주석은 편집기/IDE에서조차 읽기 어렵다.

 

 

전역 정보

 

주석을 달아야 한다면 근처에 있는 코드만 기술하자.

코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.

 

 

너무 많은 정보

 

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

 

 

모호한 관계

 

주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.

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

 

위 주석을 보면 필터 바이트가 무엇인지, (필터 바이트가 +1과 관련이 있는지, 3과 관련이 있는지, 아니면 둘다 인지...?)

200을 추가하는 이유가 무엇인지 알 수 없다.

주석 자체가 다시 설명을 요구하고 있는 안타까운 상황이다.

 

 

비공개 코드에서 Javadocs

 

공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.

시스템 내부에 속한 클래스와 함수에 Javadocs를 생성할 필요가 없다.