클린 코드 Chapter 4. 주석에 대해 정리합니다.
학습할 내용은 다음과 같습니다.
- Principle 1. 주석은 나쁜 코드를 보완하지 못한다
- Principle 2. 코드로 의도를 표현하라
- 좋은 주석의 예
- 나쁜 주석의 예
Reference
Intro
주석을 쓰는 이유는 뭘까? 유용한 정보를 제공해주기 위함이다.
그럼 나쁜 주석은 뭘까? 이해하기 어렵게 만든다.
우리는 대부분 주석을 사용할 때 우리가 짠 코드 구현에 대한 내용을 설명하기 위해서 사용하는 경우가 많다. 하지만 나쁜 코드에 딸린 주석은 코드를 보완해주지 않는다. 그러므로 다시 짜는게 좋다.
우리가 주석을 쓰는 경우는 코드로 원하는 의도를 표현하지 못해 실패를 만회하기 위해 주석을 사용한다. 그러므로 주석을 쓰기보단 코드를 고치는 방향으로 가는게 적합하다.
만약 주석을 쓴다면 주석도 코드처럼 계속 업데이트를 해줘야한다. 코드는 계속해서 변화하고 진화하지만 주석은 그렇지 못하는 경우가 흔하다.
주석은 업데이트가 되지 못해서 그릇된 정보를 전달하는 경우가 많다. 그러므로 이 부분에 대해서 신경을 많이 써야한다.
주석을 사용해야 하는 경우가 있다면 코드를 업데이트 할 때 주석도 같이 업데이트 하도록 하자. 이를 까먹지 말자.
하지만 Best Practice 는 주석이 없도록 코드로 충분히 설명할 수 있을 정도로 설계를 하는 것이다.
Principle 1. 주석은 나쁜 코드를 보완하지 못한다
코드에 주석을 추가하는 이유는 코드의 품질이 나쁘기 떄문이다.
그래서 주석을 단다. 그러기보단 코드를 고치는게 낫다.
표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 복잡하고 어수산한 주석이 많이 달린 코드보다 훨씬 좋다.
Principle 2. 코드로 의도를 표현하라
확실히 코드만으로 의도를 표현하기 힘든 경우도 많다.
하지만 조금만 더 생각해보면 코드로 대다수 의도를 표현할 수 있다.
다음 예를 비교해보자.
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if((employee.flags & HOURLY_FLAG) && employee.age > 65)
vs
if(employee.isEligibleForFullBenefits())객체 지향 프로그래밍에서 추상화를 통해 충분히 코드를 통해 의도를 표현할 수 있다.
좋은 주석의 예
법적인 주석
회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 명시할 때 필요하다.
예를 들어 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.
정보를 제공하는 주석
때로는 기본적인 정보를 주석으로 나타내면 좋다.
하지만 이런 주석이 유용하다 할지라도 가능하다면 코드로만 설명이 가능하면 좋다.
아래와 같은 예제도 함수 이름이 responderBeingTested 라고 지으면 설명하기 좋다.
// 테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance(); 다음은 좀 더 나은 예이다.
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile("\\dt:\\d*:\\d* \\w*, \\w*:\d*, \\d*");-
아무래도 정규 표현식이나 포맷터와 같은 건 코드만 보고 어떤 결과물을 만들어 내는지 어려우니까 주석을 통해 추가적인 설명을 하는게 좋아보인다.
-
이 예는 코드로 설명하기 어려운 부분을 주석으로 대신 해주는 예이다.
의도를 설명하는 주석
때떄로 주석은 구현을 이해하게 도와주는 선을 넘어서 결정에 깔린 의도까지 설명해주는 주석이 있다.
이 경우 예제는 우리가 대부분 알고 있는 메소드 compareTo() 같은 비교 우선순위를 정해주는 메소드가 있다.
이 메소드는 반환하는 값에 따라서 정렬 조건이 정해진다.
즉 함수를 이미 알고 있으므로 어떠한 의도로 정렬 기준을 설정했는지 설명해주면 도움이 된다.
이 외의 경우에는 비즈니스 로직이 아닌 테스트 코드를 작성하는데 의도를 드러내는 경우가 있다.
테스트 코드를 작성할 땐 의도를 그 코드가 정확하게 알기 힘든 경우가 있기 때문이다.
의미를 명료하게 밝히는 주석
때떄로 의미가 모호한 인수나 반환값은 그 의미를 주석을 통해 명료하게 밝힐 수 있다.
인수나 반환 값 자체를 명료하게 만드는 것이 좋겠지만 주로 표준 라이브러리라서 변경하지 못하는 코드에 이러한 주석을 적용하면 좋다.
예를 들면 다음과 같다.
assertTrue(a.compareTo(a) == 0 ) // a == a
assertTrue(a.compareTo(b) != 0 // a != b
assertTrue(a.compareTo(c) == -1) // a < c이 방식을 사용할 땐 그릇된 주석을 달지 않도록 주의하자.
결과를 경고하는 주석
때떄로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
예를 들어 다음은 특정 테스트 케이스를 꺼야하는 이유를 설명하는 주석이다
요즘에는 @Ignore 에노테이션을 통해서 테스트 케이스를 꺼버릴 수 있다. 그리고 여기에 구체적인 설명을 넣어주면 된다.
@Ignore("여유 시간이 충분하지 않다면 실행하지 마십시오.")
public void testCode(){
...
}TODO 주석
때로는 앞으로 할 일을 주석으로 남겨두면 편하다.
당장 구현하지 않아도 되는 일들을 주석으로 남겨두는 것이다. 우선순위가 높지 않은 경우, 미래에 해도 되는 일의 경우에 이렇게 남겨놓으면 좋다.
아니면 당장 구현하기 어려운 일들에 대해서 추가를 해놓거나.
요즘 IDE에서는 TODO 주석 전부를 찾아주는 기능이 있기 때문에 같이 이용하면 편하다.
중요성을 강조하는 주석
자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 갖오하기 위해서는 주석을 사용하면 편하다.
예를 들면 String 메소드인 trim()을 강조할 수 있다. 문자열이 서로 공백이 있다면 다른 문자열로 인식되기 때문이다.
공개 API 에서 Javadocs
설명이 잘 된 공개 API 는 참으로 유용하고 만족스럽다.
공개 API 를 구현한다면 Javadocs 를 작성해서 유용한 정보를 주도록 하자.
나쁜 주석이란?
주절거리는 주석
특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 주석을 다는 경우라면 시간낭비다.
주석을 단다면 좋은 주석을 달도록 노력해야한다.
주절거리는 주석은 저자만 이해하고 독자에게 무슨 뜻인지 의미를 전해주지 못하는 주석을 말한다.
독자가 모든 코드를 뒤져봐서 주석을 이해해야 한다면 그 주석은 독자와 소통이 되지 못하는 주석이다.
그러므로 주석은 바이트만 낭비할 뿐이다.
같은 이야기를 중복하는 주석
다음과 같은 주석은 코드 내용을 그대로 반복하는 주석이다.
// this.closed가 true일 때 반환되는 유틸리티 메소드다.
// 타임아웃에 도달하면 예외를 던진다.
public synchronized void waitForClose(final long timeoutMillis){
if(!closed){
throw new Exception("");
}
}여기에 있는 주석은 코드에 있는 내용을 그대로 가져간 주석이다. 아무런 정보가 없다. 도움이 되지 않는다.
오해할 여지가 있는 주석
때떄로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게 주석을 달지 못하는 경우가 있다.
이 경우 오해가 생길 수 있고 살짝 잘못된 정보로 인해 잘못된 사용을 할 수 있다.
의무적으로 다는 주석
모든 함수에 javadoc을 달거나 모든 변수에 주석을 달아야 하는 규칙은 어리석다.
굳이 주석을 달지 않아도 충분한 정보를 제공하는데 주석을 달아서 혼동을 주지말자.
다음과 같은 주석은 잘못된 정보를 제공할 여지가 있다.
/**
*
* @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.durationInMinutes = durationInMinutes;
cdList.add(cd);
}이력을 기록하는 주석
예전에는 소스 관리 프로그램이 없어서 코드를 편집할 때마다 주석으로 이력을 남겼다.
하지만 이제는 이런 주석은 필요없다. 소스 코드 관리 시스템이 발전했으므로 커밋 내용을 바탕으로 보면 된다.
있으나 마나 한 주석
때떄로 있으나 마나 한 주석을 말한다. 너무나 당연한 사실을 말하는 경우에 이렇다.
함수나 변수로 표현할 수 있는 주석
다음과 같은 코드는 변수로 뺼 수 있다. 이 코드는 주석을 달지 않아도 된다.
// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if(smodule.getDependSubsystems().contains(subSysMod.getSubSystem())
vs
ArrayList moduleDependees = smodule.getDependSubsystem();
String ourSubSystem = subSysMod.getSubSystem();
if(moduileDependes.contains(ourSubSystem))위치를 표시하는 주석
이런 경우는 거의 없겠지만 다음과 같이 때때로 프로그래머는 긴 소스 파일에서 특정 위치를 표시하기 위해서 이상한 주석을 쓰기도한다.
// Action ////////////////////////////////
이런 주석은 가독성만 낮추므로 제거해야한다. 극혐이다.
닫는 괄호에 다는 주석
떼때로 프로그래머는 닫는 괄호에 특수한 주석을 달아서 중첩이 심하고 장황한 함수를 설명한다.
그러기 보다는 함수를 줄이려 시도하자.
주석으로 처리한 코드
주석으로 처리한 코드만큼 지저분한 코드도 없다.
이런 코드는 이유가 있어서 잠시 이랬겠지 라고 생각해 다른 사람이 지우기를 주저하게 만든다.
다음 예제와 같이 소스 코드에 이런 코드가 쌓이게 하지말자
// public void run(ApplicationArguments args) throws Exception {
// StopWatch stopWatch = new StopWatch();
// stopWatch.start();
//
// stopWatch.stop();
// }HTML 주석
소스 코드에서 HTML 주석은 혐오 그 자체다.
HTML 주석은 IDE에서도 읽기 힘들다. 쓰지 말자.
전역 정보 주석
주석을 달아야 한다면 근처에 있는 정보만 설명하자. 시스템 전반적인 정보를 기술하지 말자. 맥락 상 안맞다.
너무 많은 정보
주석에다가 관련 없는 정보를 장황하게 늘어놓지 말자. 꼭 필요한 정보만 주석으로 달자.
모호한 관계를 나타내는 주석
주석과 주석이 설명 하는 코드는 둘 사이 관계가 명확해야 한다. 이왕 공들어 주석을 썼다면 정확하게 설명하려고 하자.
