프로그래머들인 주석을 엄격하게 관리해야 한다고, 그래서 복구성과 관련성과 정확성이 언제나 높아야 한다고 주장할지도 모르겠습니다. 그 의견에 동의합니다. 프로그래머들에게도 절도가 필요합니다. 하지만 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 없는 방향으로 에너지를 쏟는게 더 좋습니다.
코드는 변화하고 진화합니다. 일부가 여기서 저기로 옮겨지기도 합니다. 프러그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능합니다. 주석은 오래될수록 코드에서 멀어집니다. 오래될수록 완전히 그릇될 가능성도 커집니다.
부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁩니다. 더 이상 지킬 필요가 없는 규칙이나 지켜서는 안 되는 규칙을 명시합니다. 진실은 한 곳에만 존재합니다. 바로 코드입니다. 코드만이 정확한 정보를 제공하는 유일한 출처입니다.
우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용합니다. 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않습니다. 그러므로 주석이 필요한 상황에 처하면 곰곰이 생각하기 바랍니다.
1. 좋은 주석
1.1. 법적인 주석
때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시합니다. 예를 들어, 각 소스 파일 첫 머리에 주석으로 들어가는 저적권 정보와 소유권 정보는 필요하고도 타당합니다.
// Copyright (C) 2003,2004,2005 by Object Mentor, Inc. All rights reserved.
// GNU General Public License 버전 2 이상을 따르는 조선으로 베포한다.소스 파일 첫 머리에 들어가는 주석이 반드시 계약 조건이나 법적인 정보일 필요는 없습니다. 모든 조항과 조건을 열거하는 대신에, 가능하다면, 표준 라이선스나 외부 문서를 참조해도 됩니다.
1.2. 정보를 제공하는 주석
때로는 기본적인 정보를 주석으로 제공하면 편리합니다. 예를 들어, 다음 주석은 추상 메서드가 반환할 값을 설명합니다.
// 테스트 중인 Responder 인스턴스를 반환합니다.
protected abstract responderInsance(): Responder;때때로 위와 같은 주석이 유용하다 할지라도, 가능하다면, 함수 이름에 정보를 담는 편이 더 좋습니다. 예를 들어, 위 코드는 함수 이름을 resonderBeingTested로 바꾸면 주석이 필요 없어집니다. 다음은 좀 더 나은 예제입니다.
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
const timeMatcher = new RegExp("\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*");위에서 제시한 주석은 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명합니다. 이왕이면 시각과 날짜를 반환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔합니다. 그러면 주석이 필요 없어집니다.
1.3. 의도를 설명하는 주석
때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명합니다. 다음은 주석으로 흥미로운 결정을 기록한 예제입니다. 두 객체를 비교할 때 저자는 다른 어떤 객체보다 자기 객체에 높은 순위를 주기로 결정했습니다.
class WikiPagePath {
names: string[];
compareTo(o: object): number {
if (o instanceof WikiPagePath) {
const compressedName: string = this.names.join("");
const compressedArgumentName: string = o.names.join("");
return compressedName.localeCompare(compressedArgumentName);
}
return 1; // 오른쪽 유형이므로 정렬 순위가 더 높습니다.
}
}다음은 더 나은 예제입니다. 저자가 문제를 해결한 방식에 동의하지 않을지도 모르지만 어쨌거나 저자의 의도는 분명히 드러납니다.
Java로 구현된 단위 테스트 방식을 Typescript Jest 단위 테스트 방시으로 바꿔 표현하는데 한계가 있었습니다. 대충 이런식으로 의도를 주석으로 표현한다는 느낌만 가져가시길 바랍니니다.
async function testConcurrentAddWidgets(): void {
const widgetBuilder: WidgetBuilder = new WidgetBuilder([BoldWidget]);
const text = "'''bold text'''";
const parent: ParentWidget = new BoldWidget(new MockWidgetRoot(), "'''bold text'''");
let failFlag = false;
// 비동기를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도합니다.
const widgetBuilderAsyncList = Array.from({ length: 25000 }, () => widgetBuilder.AddWidgets(text, parent));
await Promise.all(widgetBuilderAsyncList).catch(() => {
failFlag = true;
});
expect(n).toBeFalsy();
}1.4. 의미를 명료하게 밝히는 주석
때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬어집니다. 일반적으로 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용합니다.
function testConcurrentAddWidgets(): void {
const a: WikiPagePath = PathParser.parse("PageA");
const ab: WikiPagePath = PathParser.parse("PageA.PageB");
const b: WikiPagePath = PathParser.parse("PageB");
const aa: WikiPagePath = PathParser.parse("PageA.PageA");
const bb: WikiPagePath = PathParser.parse("PageB.PageB");
const ba: WikiPagePath = PathParser.parse("PageB.PageA");
expect(a.compareTo(a) === 0).toBeTruthy(); // a === a
expect(a.compareTo(a) !== 0).toBeTruthy(); // a !== b
expect(ab.compareTo(a) === 0).toBeTruthy(); // ab
expect(a.compareTo(a) === -1).toBeTruthy(); // a < b
expect(aa.compareTo(a) === -1).toBeTruthy(); // aa <ab
expect(ba.compareTo(a) === -1).toBeTruthy(); // ba < bb
expect(b.compareTo(a) === 1).toBeTruthy(); // b > a
expect(ab.compareTo(a) === 1).toBeTruthy(); // ab < aa
expect(bb.compareTo(a) === 1).toBeTruthy(); // bb > ba
}물론 그릇된 주석을 달아놓을 위험은 상당히 높습니다. 직전 예제를 살펴보면 알겠지만, 주석이 올바른지 검증하기 쉽지 않습니다. 이것이 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유이기도 합니다. 그러므로 위와 같은 주석을 달 때는 더 나은 방법이 없는지 고밍하고 정확히 달도록 각별히 주의합니다.
1.5. 결과를 경고하는 주석
대로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용합니다. 예를 드렁, 다음은 특정 테스트 케이스를 꺼야 하는 이유를 설명하는 주석입니다.
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
function testWithReallyBigFile(): void {
// ...
}1.6. TODO 주석
때로는 앞으로 알 일을 //TODO 주석으로 남겨두면 편합니다. 다음 함수를 구현하지 않은 이유와 미래 모습을 //TODO주석으로 설명한 예입니다.
// TODO-MdM 현재 필요하지 않다
// 체크아웃 모델을 도입하면 함수가 필요 없다.
function makeVersion(): VersionInfo | null {
return null;
}요즘 나오는 대다수 IDE는 TODO 주석 전부를 찾아 보여주는 기능을 제공하므로 주석을 잊어버릴 염려는 없습니다. 하지만 어떤 용도로 사용하든 시스템에 나쁜 코드를 남겨 놓는 핑계가 되어서는 안 됩니다. 그러므로 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애라고 권합니다.
1.7. 중요성을 강조하는 주석
자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용합니다.
const listItemContent: string = match.group(3).trim();
// 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.
// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.1.8. 공개 API에서 문서화
설명이 잘 된 공개 API는 참으로 유용하고 만족스럽습니다. 하지만 이 장에서 제시하는 나머지 충고도 명심하기 바랍니다. 여느 주석과 마찬가지로 문서화 역시 독자를 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재합니다.
2. 나쁜 주석
2.1. 중복되거나 있으나 마나 한 주석
모든 함수나 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없습니다. 쉽게 말해, 코드 내용을 그대로 중복하거나 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석입니다. 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비입니다. 이와 같은 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠지거나 함수를 대충 이해하고 넘어가게 만들 수 있습니다.
짧은 함수는 긴 설명이 필요 없습니다. 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋습니다.
class AnnualDateRule {
/** 월 중 일자 */
private dayOfMonth: number;
/** 기본 생성자 */
constructor() {}
/**
* 월 중 일자를 반환합니다.
* @returns 월 중 일자
*/
getDayOfMonth(): number {}
/**
* 월 중 일자를 수정합니다.
* @param dayOfMonth 월 중 일자
*/
setDayOfMonth(dayOfMonth): void {}
}2.2. 오해할 여지가 있는 주석
때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게 주석을 달지 못하기도 합니다. 다음 코드는 같은 이야기를 중복하는 주석을 가지는 코드이면서 오해할 여지가 있는 주석을 주석을 가지는 코드입니다.
class MockResponseSender {
private closed: boolean;
// this.closed가 true일 떄 반환되는 유틸리티 메서드다.
// 타임아웃에 도달하면 예외를 던진다.
async waitForClose(timeoutMills: number): Promise<void> {
if (!this.closed) {
await new Promise<void>((resolve) => setTimeout(() => resolve(), timeoutMills));
if (!this.closed) {
throw new Error("MockResponseSender could not be closed");
}
}
}
}어째서 오해의 여지가 있는지 알겠습니까? this.closed가 true로 변하는 순간에 메서드는 반환되지 않습니다. 처음부터 this.closed가 true이거나, 아니면 무조건 타임아웃을 기다립니다. 주석에 담긴 살짝 잘못된 정보로 this.closed가 true로 변하는 순간에 함수가 반환되리라는 생각으로 어느 프로그래머가 경솔하게 함수를 호출할지도 모릅니다. 그래 놓고 불쌍한 프로그래머는 자기 코드가 굼벵이 기어가듯 돌아가는 이유를 찾느라 골머리를 앓습니다.
2.3. 이력을 기록하는 주석
예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했습니다. 당시에는 소스 코드 관리 시스템이 없었으니까. 하지만 이제는 혼란만 가중할 뿐입니다. 완전히 제거하는 편이 좋습니다.
/**
* 변경 이력 (11-Oct-2001부터)
* --------------------------------
* 11-Oct-2001 : 클래스를 다시 정리하고 새로운 패키지인 com.jrefinery.date로 옮겼다 (DG);
* 05-Nov-2001 : getDescription() 메서드를 추가했으며 NotableDate class를 제거했다 (DG);
* 12-Nov-2001 : IBD가 setDescription() 메서드를 요구한다 NotableDate 클래스를 없앴다 (DG);
* getFollowingDayOfWeek(), getNearestDayOfWeek()를 변경해 버그를 수정했다 (DG);
* 05-Dec-2001 : SpreadsheetDate 클래스에 존재하는 버그를 수정했다 (DG);
* 29-May-2002 : month 상수를 독자적인 인터페이스로 옮겼다 (MonthConstants) (DG);
*/2.4 함수나 변수로 표현할 수 있다면 주석을 달지 마라
// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem())) {
}이 코드에서 주석을 없애고 다시 표현하면 다음과 같습니다.
const moduleDependees = smodule.getDependSubsystems();
const ourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem)) {
}2.5. 위치를 표시하는 주석
떄떄로 프로그래머는 소스 파일에서 특정 위치를 표시하러 주석을 사용합니다. 극히 드물지만 아래와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있긴 있습니다. 너무 자주 사용하지 않는다면 배너는 누에 띄며 주의를 환기합니다. 그러므로 반드시 필요할 떄만, 아주 드물게 사용하는 편이 좋습니다. 그러므로 반드시 필요할 떄만, 아주 드물게 사용하는 편이 좋습니다. 배너를 남용하면 독자가 흔한 잡음을오 여겨 무시합니다.
// Action /////////////////////////////////////2.6. 닫는 괄호에 다는 주석
때로는 프로그래머들이 닫는 괄호에 특수한 주석을 달아놓습니다. 중첩이 심하고 장황한 함수라면 의미가 있을지 모르겠지만 (우리가 선호하는) 작고 캡슐화된 함수에는 잡음일 뿐입니다. 그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도합니다.
while (true) {
for (let i = 0; i < 10; i += 1) {
console.log(`Count ${i}`);
} // for
if (true) {
break;
} // if
} // while2.7. 공로를 돌리거나 저자를 표시하는 주석
/* 릭이 추가함 */소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억합니다. 저자 이름으로 코드를 오염시킬 필요가 없습니다. 주석이 있으면 다른 사람들이 코드에 관해 누구하넽 물어볼지 아니까 위와 같은 주석이 유용하다 여길지도 모르겠습니다. 하지만 현실적으로 이런 주석은 그냥 오랫동안 코드에 방치되어 점차 부정확하고 쓸모없는 정보로 변하기 쉽습니다.
2.8. 주석으로 처리한 코드
주석으로 처리한 코드는 다른 사람들이 지우기를 주저합니다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각합니다. 그래서 쓸모 없는 코드가 점차 쌓여갑니다.
this.bytePos = this.writeBytes(pngIdBytes);
// this.hdrPos = this.bytePos;
this.writeHeader();
this.writeResolution();
// this.dataPos = bytePos();
if (this.writeImageData()) {
this.writeEnd();
this.pngBytes = this.resizeByteArray(this.pngBytes, this.maxPos);
} else {
this.pngBytes = null;
}
return this.pngBytes;두 행을 주석으로 처리한 이유가 무엇일까요? 1960년대 즈음에는 주석으로 처리한 코드가 유용했었습니다. 하지만 우리는 오래 전부터 우수한 소스 코드 관리 시스템을 사용했습니다. 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해줍니다. 이제는 주석으로 처리할 필요가 없습니다. 그냥 코드를 삭제하세요.
2.9. HTML 주석
소스 코드에서 HTML 주석은 혐오 그 자체입니다. HTML 주석은 (주석을 읽기 쉬워야 하는) 편집기/IDE에서조차 읽기가 어렵습니다. 도구로 주석을 뽑아 웹 페이지에 올릴 작정이라면 주석에 HTMl 태그를 삽입해야 하는 책임은 프로그래머가 아니라 도구가 가져야 합니다.
/**
* 적합성 테스트를 수행하기 위한 과업
* 이 과업은 적합성 테스트를 수행해 결과를 출력한다.
* <p/>
* <pre>
* 용법:
* <taskdef name="execute-fitnesse-tests" classname="fitnesse.ant.ExecuteFitnesseTestsTask" classpathref="classpath" />
* 또는
* <taskdef classpathref="classpath" resource="tasks.properties" />
* </p>
* ...
*/2.10. 전역 정보
주석을 달아야 한다면 근처에 있는 코드만 기술합니다. 코드 일부에 주석을 달면서 시스템의 전반적은 정보를 기술하면 안됩니다. 예를 들어, 다음 주석은 심하게 중복되었다는 사실 외에도 기본 포트 정보를 기술합니다. 하지만 함수 자체는 포트 기본값을 전혀 통제하지 못합니다. 그러니까 아래 주석은 바로 아래 함수가 아니라 시스템 어딘가에 있는 다른 함수를 설명한다는 말입니다. 즉, 포트 기본값을 설정하는 코드가 변해도 아래 주석이 변하리라는 보장은 전혀 없습니다.
/**
* 적합성 테스트가 동작하는 포트: <b>8082</b>
* @param fitnessePort
*/
setFitnessePort(fitnessePort: number) {
this.fitnessePort = fitnessePort;
}2.11. 너무 많은 정보
주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓으면 안됩니다.
/**
* RFC 2045 - Multipurpose Internet Mail Extensions (MIME)
* 1부: 인터넷 메시지 본체 형식
* 6.8절. Base64 내용 전송 인코딩(Content-Transfer-Encoding)
* 인코딩 과정은 입력 비트 중 24비트 그룹을 인코딩된 4글자로 구성된 ...
*/2.12. 모호한 관계
주석과 주석이 설명하는 코드는 둘 사이 관계가 명뱁해야 합니다. 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력합니다. 이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석입니다.
/**
* 모든 픽셀을 담을 만큼 충분한 버퍼로 시작합니다(여기에 필터 바이트를 더합니다.)
* 그리고 헤더 정보를 위해 200바이트를 더합니다.
*/
this.pngBytes = new ArrayBuffer((this.width + 1) * this.height * 3 + 200);여기서 필터 바이트가 무엇인지, 1과 200을 더하는 이유가 무엇인지, 3을 곱하는 이유가 무엇인지 알 수 없습니다. 주석을 다는 목적은 코드만으로 설명이 부족해서입니다.
3. 예제
클린코드 책 원문은 Java로 작성된 객체지향 코드입니다. 하지만 저는 원문 코드를 나름대로 해석해 Typescript를 사용한 함수지향적 코드로 변경했습니다. 다음에 나올 코드는 원문과 다른, 제가 임의로 수정한 코드 예시입니다.
엉성한 코드 원본
/**
* 이 클래스는 사용자가 지정한 최대 값까지 소수를 생성한다. 사용된 알고리즘은 에라스토테네스의 체다.
* <p>
* 에라스토테네스: 기원전 276년에 라비아 카레네에서 출생, 기원전 194년에 사망
* 지구 둘레를 최초로 계산한 사람이자 달력에 윤년을 도입한 사람
* 알렉산드리아 도서관장을 역임
* <p>
* 알고리즘은 상당히 단순하다. 2에서 시작하는 정수 배열을 대상으로 2의 배수를 모두 제거한다.
* 다음으로 남은 정수를 찾아 이 정수의 배수를 모두 지운다.
* 최대 값의 제곱근이 될 떄까지 이를 반복한다.
*
* @author Alphonse
* @version 13 Feb 2002 atp
*/
/**
* @param maxValue 소수를 찾아낼 최대 값
*/
function generatePrimes(maxValue: number): number[] {
if (maxValue >= 2) {
// 유일하게 유효한 경우
// 선언
const s = maxValue + 1; // 배열 크기
const f = Array<boolean>(s);
// 배열을 참으로 초기화
for (let i = 0; i < s; i += 1) {
f[i] = true;
}
// 소수가 아닌 알려진 숫자를 제거
f[0] = false;
f[1] = false;
// 체
for (let i = 2; i < Math.sqrt(s) + 1; i += 1) {
if (f[i]) {
// i가 남아있는 숫자라면 이 숫자의 배수를 구한다.
for (let j = 2 * i; j < s; j += 1) {
f[j] = false; // 배수는 소수가 아니다.
}
}
}
// 소수의 개수는?
let count = 0;
for (let i = 0; i < s; i += 1) {
if (f[i]) {
count += 1; // 카운트 증가
}
}
const primes = Array<number>(count);
// 소수를 결과 배열로 이동합니다.
for (let i = 0, j = 0; i < s; i += 1) {
if (f[i]) {
// 소수일 경우에
primes[j] = i;
j += 1;
}
}
return primes; // 소수를 반환한다.
} else {
// maxValue < 2
return []; // 입력이 잘못되면 비어 있는 배열을 반환한다.
}
}리펙터링 결과
/**
* 이 클래스는 사용자가 지정한 최대 값까지 소수를 구한다.
* 알고리즘은 에라스토테네스 체다.
* 2에서 시작하는 정수 배열을 대상으로 작업한다.
* 처음으로 남아 있는 정수를 찾아 배수를 모두 제거한다.
* 배열에 더 이상 배수가 없으 ㄹ떄까지 반복한다.
*/
function generatePrimes(maxValue: number): number[] {
if (maxValue < 2) return [];
const uncrossIntegers = uncrossIntegersUpTo(maxValue);
const crossedOut = crossOutMultiples(uncrossIntegers);
const uncrossedIntegersList = getUncrossedIntegersList(crossedOut);
return uncrossedIntegersList;
}
function uncrossIntegersUpTo(maxValue: number): boolean[] {
return Array<boolean>(maxValue + 1).fill(false);
}
function crossOutMultiples(uncrossIntegers: boolean[]): boolean[] {
const limit = determineIterationLimit(uncrossIntegers.length);
let crossedOut = uncrossIntegers;
for (let i = 2; i <= limit; i += 1) {
if (crossedOut[i] === false) {
crossedOut = crossOutMultiplesOf(i, crossedOut);
}
}
return crossedOut;
}
function determineIterationLimit(uncrossIntegersLength: number): number {
// 배열에 있는 모든 배수는 배열 크기의 제곱근보다 작은 소수의 인수이다.
// 따라서 이 제곱근보다 더 큰 숫자의 배수는 제거할 필요가 없다.
const iterationLimit = Math.sqrt(uncrossIntegersLength);
return Math.floor(iterationLimit);
}
function crossOutMultiplesOf(i: number, crossedOut: boolean[]): boolean[] {
const nextdCrosedsOut = [...crossedOut];
for (let multiple = 2 * i; multiple < crossedOut.length; multiple += i) {
nextdCrosedsOut[multiple] = true;
}
return nextdCrosedsOut;
}
function getUncrossedIntegersList(crossedOut: boolean[]): number[] {
const uncrossedIntegersList = [];
for (let i = 2; i < crossedOut.length; i += 1) {
if (crossedOut[i] === false) {
uncrossedIntegersList.push(i);
}
}
return uncrossedIntegersList;
}첫 번째 주석이 중복이이라고 주장하기 쉽습니다. 설명이 generatePrimes 함수 자체와 아주 흡사하기 때문입니다. 그래도 나는 주석이 있어야 알고리즘을 이해하기 쉬워진다고 생각합니다. 그래서 남겨 두는 편을 택했습니다.
두 번째 주석은 거의 확실히 필요합니다. 루프 한계값으로 제곱근을 사용한 이유를 설명합니다. 나로서는 변수 이름을 바꾸거나 코드 구조를 조정해 이유를 명확하게 설명할 방법을 찾지 못했습니다.
4. 출처
- 제목: 클린 코드 - 애자일 소프트웨어 장인 정신
- 저자: 로버트 C.마틴
- 옮긴이: 박재호, 이해영
- 출판사: 인사이트
