4장. 주석

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.
코드는 변화하고 진화하며, 일부가 여기서 저기로 옮겨지고 합쳐지는 과정을 거친다. 그 동안 주석은 코드를 따라가지 못해 그릇된 정보를 알려줄 때가 많다.
코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처이므로 주석을 가능한 줄이도록 노력해야한다.

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

표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

코드로 의도를 표현하라!

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

if (employee.isEligibleForFullBenefits())
위 두 코드를 살펴보면 코드로 대다수 의도를 표현할 수 있음을 알 수 있다.
많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

좋은 주석

종종 필요하거나 유익한 주석은 다음과 같다. 그러나 정말로 좋은 주석은 주석을 달지 않을 방법을 찾아낸 주석이다.

법적인 주석

소스파일 첫머리에 주석으로 들어가는 저작권 정보, 소유권 정보

정보를 제공하는 주석

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

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

//위 주석 개선코드 예제 -> 함수명 변경
protected abstract Responder responderBeingTested();

//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 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로 떡칠한 코드는 바람직하지 않으므로 주기적으로 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 FioleInputStream(propertiesPath);
        loadedProperties.load(propertiesStream);
    }catch (IOException e) {
    	//속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
    }
}

위 예제에서 catch 블록에 있는 주석은 의미가 타인에게 제대로 전해지지 않는다. 답을 알아내려면 다른 코드를 뒤져보는 수 밖에 없는데, 이런 주석은 독자와 제대로 소통하지 못하는 주석이다.

같은 이야기를 중복하는 주석

헤더에 달린 주석이 같은 코드 내용을 그대로 중복한다.

//4-2/ContainerBase.java/출처:톰캣
public abstract class ContainerBase implements Container, LifeCycle, Pipeline, MBeanRegistration, Serializable {
	/**
    * 이 컴포넌트의 프로세서 지연값
    */
    protected int backgroundProcessorDelay = -1;
    
    /**
    * 이 컴포넌트를 지원하기 위한 생명주기 이벤트
    */
    protected LifecycleSupport lifecycle = new LifeCycleSupport(this);
    
    /**
    * 이 컴포넌트를 위한 컨테이너 이벤트 Listener
    */
    protected ArrayList listeners = new ArrayList();
    
    /**
    * 컨테이너와 관련된 Loader 구현
    */
    protected Loader loader = null;
}

의무적으로 다는 주석

아래 예제처럼 모든 함수에 Javadocs를 넣으라는 규칙은 코드를 복잡하고 헷갈리게 만들며, 잘못된 정보를 제공할 여지를 만든다.

//4-3
/**
 *
 * @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);
 }

이력을 기록하는 주석

모듈 첫머리 주석이 지금까지 모듈에 가한 변경을 모두 기록하는 일종의 일지 또는 로그 역할을 한다. 예전에는 이가 바람직했으나, 현재는 소스코드관리시스템이 존재하므로 부적절하다.

있으나 마나 한 주석

너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
아래 예제에서 첫 번째 주식은 catch 블록을 무시해도 괜찮은 이유를 설명하는 적절한 주석이다. 그러나 두 번째 주석은 쓸모가 없다.

//4-4/startSending
private void startSending() {
	try {
    	doSending();
    } catch(SocketException e) {
    	//정상. 누군가 요청을 멈췄다.
    } catch(Exception e) {
    	try{
        	response.add(ErrorResponder.makeExceptionString(e));
            response.closeAll();
        }catch(Exception e1) {
        	//이게 뭐야!
        }
    }
}

//4-5/startSending(리팩토링)
private void startSending() {
	try {
    	doSending();
    } catch(SocketException e) {
    	//정상. 누군가 요청을 멈췄다.
    } catch(Exception e) {
    	addExceptionAndCloseResponse(e);
    }
}

private void addExceptionAndCloseResponse(Exception e) {
	try{
        response.add(ErrorResponder.makeExceptionString(e));
        response.closeAll();
    }catch(Exception e1) {
    }
}

무서운 잡음

단지 문서를 제공해야 한다는 잘못된 욕심으로 작성한 주석은 잡음을 발생시킨다.

/** The name. */
private String name;

/** The version. */
private String version;

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

주석이 필요하지 않도록 코드를 개선하는 편이 더 낫다.

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

/** 리팩토링코드 **/
ArrayList moduleDependees = smodule.getDependSubsystems();
String ourSubSystem = subSysMod.getSubSystem();
if(moduleDependees.contains(ourSubSystem))

위치를 표시하는 주석

때때로 프로그래머는 소스 파일에서 특정 위치를 표시하려 주석을 사용한다. 이는 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.

닫는 괄호에 다는 주석

중첩이 심하고 장황한 함수라면 의미가 있을 수 있으나, 작고 캡슐화된 함수에는 그저 잡음일 뿐이다. 닫는 괄호에 주석을 다는 대신 함수를 줄이려 시도하는 편이 효율적이다.

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

소스코드 관리시스템을 사용하므로 굳이 누가 작성했는지를 코드에 기록할 필요는 없다.

주석으로 처리한 코드

주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨 놓았으리라고, 중요하니까 지우면 안된다고 생각한다. 그렇게 쓸모없는 코드가 쌓이는 현상이 발생한다. 소스코드 관리시스템에 기록이 남아있으므로 주석으로 처리한 코드는 삭제하는 편이 좋다.

HTML 주석

주석에 html을 사용할 필요 없다.

전역 정보

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

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

너무 많은 정보

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

모호한 관계

주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. 주석을 다는 목적은 코드만으로 설명이 부족해서 이다. 주석 자체가 다시 설명을 요구해서는 안된다.

함수 헤더

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

비공개 코드에서 Javadocs

공개하지 않을 코드에서 Javadocs는 불필요하다. 유용하지 않을 뿐만 아니라 Javadocs 주석이 요구하는 형식으로 인해 코드만 보기 싫고 산만해진다.

예제

// 4-7/GeneratePrimes.java
/**
 * 이 클래스는 사용자가 지정한 최대 값까지 소수를 생성한다. 사용된 알고리즘은
 * 에라스토테네스의 체다.
 * <p>
 * 에라스토테네스: 기원전 276년에 리비아 키레네에서 출생, 기원전 194년에 사망
 * 지구 둘레를 최초로 계산한 사람이자 달력에 윤년을 도입한 사람.
 * 알렉산드리아 도서관장을 역임.
 * <p>
 * 알고리즘은 상당히 단순하다. 2에서 시작하는 정수 배열을 대상으로
 * 2의 배수를 모두 제가한다. 다음으로 남은 정수를  찾아 이 정수의 배수를 모두 지운다.
 * 최대 값의 제곱근이 될 때까지 이를 반복한다.
 * 
 * @author Alphonse
 * @version 13 Feb 2002 atp
 */
import java.util.*;

public class GeneratePrimes 
{
	/**
     * @param maxValue는 소수를 찾아낼 최대 값
     */
    public static int[] generatePrimes(int maxValue) 
    {
    	if(maxVlaue >= 2) // 유일하게 유효한 경우
        {
        	// 선언
            int s = maxVlaue +1; // 배열 크기
            boolean[] f = new boolean[s];
            int i;
            
            // 배열을 참으로 초기화
            for(i = 0; o < s; i++)
            	f[i] = true;
            
            // 소수가 아닌 알려진 숫자를 제거
            f[0[ = f[1] = false;
            
            int j;
            for(i = 2; i < Math.sqrt(s); 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]; // 입력이 잘못되면 비어 있는 배열을 반환한다.
    }
}

// 4-8/GeneratePrimes.java/리팩토링
/**
 * 이 클래스는 사용자가 지정한 최대 값까지 소수를 구한다.
 * 알고리즘은 에라스토테네스의 체다.
 * 2에서 시작하는 정수 배열을 대상으로 작업한다.
 * 처음으로 남아있는 정수를 찾아 배수를 모두 지운다.
 * 배열에 더 이상 배수가 없을 때까지 반복한다.
 */
import java.util.*;

public class GeneratePrimes 
{
	private static boolean[] crossedOut;
    private static int[] result;
    
    public static int[] generatePrimes(int maxValue) 
    {
    	if(maxVlaue >= 2)
        	return new int[0];
        else
        {
        	uncrossIntegerUpTo(maxValue);
            crossOutMultiples();
            putUncrossedIntegerIntoResult();
            return result;
        }
    }
    
    private static void uncrossIntegerUpTo(int maxValue)
    {
    	crossedOut = new boolean[maxValue + 1];
        for (int i = 2; i < crossedOut.length; i++)
        	crossedOut[i] = false;
    }
    
    private static void crossOutMultiples()
    {
    	int limit = determineIterationLimit();
        for (int i = 2; i <= limit; i++) 
        	if(not Crossed(i))
            	crossOutMultiplesOf(i);
    }
    
    private static int determineIterationLimit()
    {
    	//배열에 있는 모든 배수는 배열 크기의 제곱근보다 작은 소수의 인수다.
        //따라서 이 제곱근보다 더 큰 숫자의 배수는 제거할 필요가 없다.
        double iterationLimit = Math.sqrt(crossedOut.length);
        return (int) iterationLimit;
    }
    
    private static void crossOutMultiplesOf(int i)
    {
    	for (int multiple = 2*i; multiple < crossedOut.length; multiple += i)
        	crossedOut[multiple] = true;
    }
    
    private static boolean notCrossed(int i)
    {
    	return crossedOut[i] == false;
    }
    
    private static void putUncrossedIntegersIntoResult()
    {
    	result = new int[numberOfUncrossedIntegers()];
        for(int j = 0, i = 2; i < crossedOut.length; i++)
        	if(notCrossed(i))
            	result[j++] = i;
    }
    
    private static int numberOfUncrossedIntegers()
    {
    	int count = 0;
        for (int i = 2; i < crossedOut.length; i++)
        	if(notCrossed(i))
            	count++;
                
        return count;
    }
}