[Clean Code] 4장, 주석

 

클린코드,  애자일 소프트웨어 장인정신

Robert C. Martin

 

 

들어가며

나쁜 코드에 주석을 달지 마라. 새로 짜라.
- Brian Wilson Kernighan, Phillip James Plauger

 

• 주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다.
• 상황을 역전해 코드로 의도를 표현할 방법은 없을까?
• 코드로 의도를 표현할 때마다 스스로를 칭찬해준다.
• 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다. 

 

• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.
• 코드만이 자기가 원하는 일을 진실되게 말한다.
• 그러므로 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

 

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

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

 

코드로 의도를 표현하라!

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

• 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
• 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

if(employee.isEligibleForFullBenefits())

 

좋은 주석

법적인 주석

• 때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
• 반드시 계약 조건이나 법적인 정보일 필요는 없다.
• 가능하다면, 표준 라이선스나 외부 문서를 참조해도 되겠다.

 

정보를 제공하는 주석

• 때로는 기본적인 정보를 주석으로 제공하면 편리하다.
• 그러나 가능하다면, 함수 이름에 정보를 담는 편이 더 좋다.

 

의도를 설명하는 주석

• 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.

 

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

• 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 유용하다.
• 그러나 주석이 올바른지 검증하기 쉽지 않기 때문에 더 나은 방법이 없는지 고민하고 정확히 달도록 하자.

 

결과를 경고하는 주석

• 때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
• 요즘에는 @Ignore 속성을 사용한다.("구체적인 설명")

 

TODO 주석

• '앞으로 할 일'을 //TODO 주석으로 남겨두면 편하다.
• 그러나 TODO로 떡칠한 코드는 바람직하지 않다.
• 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석을 없애라고 권한다.

 

중요성을 강조하는 주석

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

 

공개 API에서 Javadocs

• 설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다.(표준 자바 라이브러리에서 사용한 Javadocs)
• 그러나 Javadocs 역시 독자를 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재한다.

 

 

나쁜 주석

주절거리는 주석

• 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.

 

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

• 자칫하면 코드보다 주석을 읽는 시간이 더 오래걸린다.

 

오해할 여지가 있는 주석

• 다음 코드는 this.closed가 true로 변하는 순간에 메서드는 반환되지 않는다.
• this.closed가 true여야 메서드는 반횐된다.
• 아니면 무조건 타임아웃을 기다렸다 this.closed가 그래도 true가 아니면 예외를 던진다.
• 주석에 담긴 '살짝 잘못된 정보'로 인해 this.closed가 true로 변하는 순간에 함수가 반환되리라는 생각으로
  어느 프로그래머가 경솔하게 함수를 호출할지도 모른다.

// 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");
    }
}

 

의무적으로 다는 주석

• 모든 함수에 javadocs를 달거나 모든 변수에 주석을 달면 코드가 복잡해지고, 혼동과 무질서를 초래한다.

 

이력을 기록하는 주석

• 과거에는 모듈 편집시 모듈 첫머리에 주석을 추가했다.
• 지금은 소스 코드 관리 시스템이 있으니 완전히 제거하는 편이 좋다.

 

있으나 마나 한 주석

• 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석
• 있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라.

 

무서운 잡음

• 때때로 javadocs도 잡음이다.

 

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

• 주석으로 설명한 코드

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

• 주석을 지우고 함수와 변수로 표현한 코드

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

 

위치를 표시하는 주석

• 너무 자주 사용하지 않는다면 배너는 눈에 띄며 주의를 환기한다.
• 배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다.

 

닫는 괄호에 다는 주석

• 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 (우리가 선호하는) 작고 캡슐화된 함수에는 잡음일 뿐이다.
• 그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.

 

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

• 소스 관리 시스템에 저장하는 편이 좋다.

 

주석으로 처리한 코드

• 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.
• 소스 코드 관리 시스템이 대신 코드를 기억해주니 이제는 주석으로 처리할 필요가 없다.

 

HTML 주석

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

 

전역 정보

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

 

너무 많은 정보

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

 

모호한 관계

• 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
• 주석 자체가 다시 설명을 요구하면 안된다.

 

함수 헤더

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

 

비공개 코드에서 Javadocs

• 공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.
• 시스템 내부에 속한 클래스와 함수에 Javadocs를 생성할 필요는 없다.