[클린코드(CleanCode)] 4장. 주석

 

 

나쁜 코드에 주석을 달지 마라. 새로 짜라

 

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

코드만이 자기가 하는 일을 진실되게 말한다

우리는 주석을 가능한 줄이도록 꾸준히 노력하자

 

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다

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

 

코드로 의도를 표현하라

확실히 코드만으로 의도를 설명하기 어려운 경우가 존재할 수 있음

하지만, 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있음

주석으로 달려는 설명을 함수로 만들어 표현해도 충분함

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

vs

if (employee.isEligibleForFullBenefits())

좋은 주석

어떤 주석은 필요하거나 유익

하지만 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을 명심!

 

법적인 주석

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

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

// General public license 버전 2 이상 ~

 

정보를 제공하는 주석

때로 기본적인 정보를 주석으로 제공하면 편함

// 테스트 중인 Responder 인스턴스를 반환
protected abstract Responder responderInstance();
-> 함수 이름에 정보를 담는 편이 더 좋음 (responderBeingTested)

// kk:mm:ss EEE, MMM dd, yyyy 형식
Pattern timeMather = Pattern.compile("\\d*:\\d*~~");
-> 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔
(주석도 필요 없어짐)

의도를 설명하는 주석

때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명 (저자의 의도가 분명히 드러나는 주석)

 

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

때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다

→ 인수, 반환값 자체를 명확히 하면 좋지만, 수정할 수 없는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용함

assertTrue(b.compareTo(a) == 1); // b > a

→ 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유 (주석이 올바른지 검증하기 힘듬)

그러므로 위와 같은 주석을 달 땐 더 나은 방법이 없는지 고민하고 정확히 달도록 주의!

 

결과를 경고하는 주석

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

// 여유 시간이 충분하지 않다면 실행하지 마세요
public void _testWithReallyBigFile() {
~
}

→ 물론 요즘은 @Ignore 속성으로 테스트 케이스를 끌 수 있음

Junit4가 나오기 전에 메서드 이름 앞에 _ 기호를 붙이는 방법이 일반적인 관례

public static SimpleDateFormat makeStandardHttpDateFormat() {
	// SimpleDateFormat은 쓰레드에 안전하지 못함
	// 따라서 각 인스턴스는 독립적으로 생성해야함
	SimpleDateFormat df = new SimpleDateFormat(~)
}

→ 프로그램 효율을 높이기 위해 정적 초기화 함수를 사용하려던 열성적인 프로그래머가 주석 때문에 실수를 면할 수 있음

 

TODO 주석

앞으로 할 일

필요하지만 당장 구현하기 어려운 업무를 기술

ex) 더 이상 필요 없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용

 

중요성을 강조하는 주석

자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용

String listItemContent = match.group(3).trim();
// 여기서 trim은 정말 중요! trim 함수는 문자열에서 시작 공백을 제거
// 문자열에 시작 공백이 있으면 다른 문자열로 인식

 

공개 API에서 Javadocs

공개 API를 구현했다면 반드시 훌륭한 Javadocs를 작성하자

 

나쁜 주석

대다수 주석이 나쁜 주석

 

주절거리는 주석

특별한 이유 없이 의무감 또는 마지못해 주석을 단다면 전적으로 시간낭비

주석이 이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석

그런 주석은 바이트만 낭비할 뿐

 

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

코드랑 같은 이야기를 하거나, 코드보다 읽기 쉽지 않은 주석은 달지 않는다

 

오해할 여자가 있는 주석

의미가 모호하여 주석을 잘못 이해한다면, 실수를 할 수 있음

 

의무적으로 다는 주석

/**
	@param title CD 제목
	@param author CD 저자
*/

→ 이런 주석은 코드를 복잡하게 하며, 거짓말을 퍼뜨리고 혼동과 무질서를 초래

 

이력을 기록하는 주석

/**
변경 이력 (11-Oct-2001부터)
----
11-Oct-2001: ~
05-Nov-2001: ~
*/

→ 예전에는 이런 관례가 바람직했으나, 요즘은 소스 코드 관리 시스템이 있으므로 제거하는 것이 좋음

 

있으나 마나 한 주석

생성자, 변수설명, 리턴설명 등등 (지나친 참견이다)

 

무서운 잡음

때로는 Javadocs도 잡음 (단지 문서를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음)

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

 

위치를 표시하는 주석

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

ex) // Actions ////////////////////////

이 같은 주석은 가독성만 낮추므로 제거해야함 (특히 뒷부분에 슬래시(/)로 이어지는 잡음은 제거)

배너를 반드시 필요할 때만 사용, 배너를 남용하면 독자가 흔한 잡음으로 여겨 무시함

 

닫는 괄호에 다는 주석

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

try {
	while(~) {
	} // while
} // try
catch (IOException e) {

} // catch

→ 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만, 잡음이다

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

 

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

예) /* 잭코딩 추가함 *

소스 코드 관리 시스템에 이력이 나오므로 코드를 오염시키지 말자

 

주석으로 처리한 코드

주석으로 처리된 코드는 다른 사람들이 지우기를 주저

이유가 있어서 남겨놓았다고 생각

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

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

그냥 삭제하라. 잃어버릴 염려는 없다

 

HTML 주석

HTML 주석은 혐오 그 자체다

 

전역 정보

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

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

// port 기본 값은 8082
public void setPort(int port) {
	this.port = port;
}

→ 함수 자체는 포트 기본값을 전혀 통제하지 못함

즉, 포트 기본값을 설정하는 코드가 변해도 아래 주석이 변하리라는 보장은 전혀 없음

 

너무 많은 정보

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

 

모호한 관계

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

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

→ 필터 바이트? 200을 추가하는 이유?

주석 자체가 다시 설명을 요구하니 안타깝다

 

함수 헤더

짧은 함수는 긴 설명이 필요 없음

짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋음

 

비공개 코드에서 Javadocs

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

 

 

이 글은 “클린코드” 책 내용을 정리한 글입니다.

만약 저작권 관련 문제가 있다면 “shk3029@kakao.com”로 메일을 보내주시면, 바로 삭제하도록 하겠습니다.