4장 주석

주석

---

코드에 의미를 명확하게 담도록 노력하고 주석은 왠만하면 사용을 안하는것이 좋다

사용을한다면 좋은 주석을 쓰는것이 좋다

나쁜코드에 주석을 달지말고 좋은 코드로 바꿔라

안좋은 주석은 없는것보다 훨씬 나쁘다

코드만이 정확한 정보를 제공하는 유일한 출처다

좋은 주석 

---

정말 좋은 주석은 주석을 달지 않는것이지만 어쩔수 없이 달아야한다면 다음과 같은 주석을 달길 바란다

법적인 주석

---

저작권, 날짜 등을 알려주는 주석

ex) 

// Copyright (C) 2003,2004,2005 by Object Mentor, Inc. All rights reserved.

// GNU General Public License 버전 2 이상을 따르는 조건으로 배포한다.

중요도를 알려주는 주석

---

코드를 볼 사람을 위해 뭐가 중요하다고 알려주는 주석

ex) 

String listltemContent = match.group(3).trim();

// 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.

// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.

new ListltemWidget(this, listltemContent, this.level + 1);

return buildList(textsubstring(match.end()));

정보를 알려주는 주석

---

ex) 

// kk:mm:ss EEE, MMM dd, yyyy 형식이다.

    Pattern timeMatcher = Pattern.compile(

    M\\d*:\\d*:\\d* \\w*# \\w* \\d*, \\d*");

의도를 설명하는 주석

---

ex) 

// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.

for (int i = 0; i < 25000; i++) {

WidgetBuilderThread widgetBuilderThread =

new WidgetBuilderThread(widgetBuilder, text, parent, failFlag);

Thread thread = new Thread(widgetBuilderThread);

thread.start();

}

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

---

ex) 

assertTrue(a.compareTo(a) = 0); // a == a

assertTrue(a.compareTo(b) != 0); // a != b

assertTrue(ab.compareTo(ab) :== 0); // ab == ab

위와 같은 주석을 달 때는 더 나은 방법 이 없는지 고민하고 정확히 달도록 각별히 주의 한다.

결과를 경고하는 주석

---

ex) 

// 여유 시간이 충분하지 않다면 실행하지 마십시오.

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로 떡칠한 코드는 바람직하지않다. 그러므로 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애라고 권한다

나쁜 주석

---

대다수 주석이 이 범주에 속한다

주절거리는 주석

---

try

{

String propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE;

FilelnputStream propertiesStream = new FilelnputStream(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");

}

}

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

오해할 여지가 있는 주석

---

// 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가 아니면 예외를 던진다

의무적으로 다는 주석

---

모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다

아래와 같은 주석은 아무 가치도 없다. 오히려 코드만 헷갈리게 만들며, 거짓말할 가능성을 높이며, 잘못된 정보를 제공할 여지만 만든다

/ 

* @param title CD 제목

* (Qparam author CD 저자

* @param tracks CD 트랙 숫자

* (aparam durationlnMinutes CD 길이(단위: 분)

*/

public void addCD(String title, String author,int tracks, int durationlnMinutes) {

CD cd = new CD();

cd.title = title;

cd.author = author;

cd.tracks = tracks;

cd.duration = durationlnMinutes;

cdList.add(cd);

}

이력을 기록하는 주석

---

* 변경 이력 (U-Oct-2001부터)

* ----------------------

* 11-Oct-2001 : 클래스를 다시 정리하고 새로운 패키지인 com.jrefinery.date로 옮겼다 (DG);

* 05-Nov-2001 : getDesc ript ion () 메서드를 추가했으며

* NotableDate class를 제거했다 (DG);

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

당시에는 소스 코드 관리 시스템이 없었으니까. 하지만 이제는 혼란만 가중할 뿐이다. 

완전히 제거하는 편이 좋다

있으나마나한 주석

---

때때로 있으나 마나 한 주석을 접한다. 쉽게 말해 , 너무 당연한 사실을 언급하며

새로운 정보를 제공하지 못하는 주석이다

// 기본 생성자

protected AnnualDateRule() {

}

있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라. 더 낫고，행복한 프로그래머가 되는 지름길이다.

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

---

// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?

if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))

이 코드에서 주석을 없애고 다시 표현하면 다음과 같다.

ArrayList moduleDependees = smodule.getDependSubsystems();

String ourSubSystem = subSysMod.getSubSystem();

if (moduleDependees.contains(ourSubSystem))

위치를표시하는 주석

---

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

// Actions ////////////////////////////////////

극히 드물지만 위와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있긴 있다

그러므로 반드시 필요할 때만，아주 드물게 사용하는 편이 좋다. 배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다

닫는 괄호에 다는 주석

---

때로는 프로그래머들이 닫는 괄호에 특수한 주석을 달아놓는다

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

그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자

public class wc {

public static void main(String[] args) {

BufferedReader in = new BufferedReader(newInputStreamReader(System.in));

String line;

int lineCount = 0;

int charCount = 0;

int wordCount = 0;

try {

while ((line = in.readLineO) != null) {

lineCount++;

charCount += line.length();

String words[] = line.split("\\W");

wordCount += words.length;

} //while

System.out.printIn("wordCount = " + wordCount);

System.out.printIn("lineCount = " + lineCount);

System.out.printIn("cha rCount = " + charCount);

} //try

주석으로 처리한 코드

---

주석으로 처리한 코드만큼 밉살스러운 관행도 드물다. 다음과 같은 코드는 작성하지 마라!

InputStreamResponse response = new InputStreamResponse();

response.setBody(formatter.getResultStream(), formatter.getByteCount());

// InputStream resultsStream = formatter.getResultStream();

// StreamReader reader = new StreamReader(resultsStream);

// response. setContent( reader. read(form atter.getByteCount( ) ) ) ;

주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고，

중요하니까 지우면 안 된다고 생각한다. 

그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다

소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다. 

그냥 코드를 삭제하라. 잃어버릴 염려는 없다. 약속한다

HTML 주석

---

소스 코드에서 HTML 주석은 혐오 그 자체다

/ **

* 적합성 테스트를 수행하기 위한 과업

* 이 과업은 적합성 테스트를 수행해 결과를 출력한다.

* <p/>

* <pre>

* 용법:

* &lt;taskdef name=&quot;execute-fitnesse-tests&quot;

* classname=&quot;fitnesse.ant.ExecuteFitnesseTestsTask&quot;

주석에 HTML 태그를 삽입해야 하는 책임은 프로그래머가 아니라 도구가 져야한다

전역 정보

---

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

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

/*

* 적합성 테스트가 동직하는 포트: 기본값은 <b>8082</b>.

* (aparam 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];

여기 서 필터 바이트란 무엇일까? +1과 관련이 있을까? 아니면 *3과 관련이 있을까? 아니면 둘 다? 한 픽셀이 한 바이트인가? 200을 추가하는 이유는? 주석을 다는 목적은 코드만으로 설명이 부족해서다

함수 헤더

---

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

예제

---

/

* 이 클래스는 사용자가 지정한 최대 값까지 소수를 생성한다. 사용된 알고리즘은

* 에라스토테네스의 체다.

* <p>

* 에라스토테네스: 기원전 276년에 리비아 키레네에서 출생, 기원전 194년에 사망

* 지구 둘레를 최초로 계산한 사람이자 달력에 윤년을 도입한 사람.

* 알렉산드리아 도서관장을 역임.

* <p>

* 알고리즘은 상당히 단순하다. 2에서 시작하는 정수 배열을 대상으로

* 2의 배수를 모두 제거한다. 다음으로 남은 정수를 찾아 이 정수의 배수를 모두 지운다.

* 최대 값의 제곱근이 될 때까지 이를 반복한다.

* ^author Alphonse

* (aversion 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[l] = 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[il)

count++; // 카운트 증가

}

int[] primes = new int [count];

// 소수를 결과 배열로 이동한다.

for (i = 0, j = 0; i < s; i++)

리팩토링 결과

/

* 이 클래스는 사용자가 지정한 최대 값까지 소수를 구한다.

* 알고리즘은 에라스토테네스의 체다.

* 2에서 시작하는 정수 배열을 대상으로 작업한다.

* 처음으로 남아 있는 정수를 찾아 배수를 모두 제거한다.

* 배열에 더 이상 배수가 없을 때까지 반복한다.

/

주석이 많이 없어짐 귀찮으니까 알꺼라 생각한다