주석은 나쁜 코드를 보완하지 못한다
- 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.
- 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다.
그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.
- 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
- 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!
코드로 의도를 표현하라!
- 확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다.
- 하지만 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
- 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.
// bad
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))
// good
if (employee.isEligibleForFullBenefits())
좋은 주석
- 어떤 주석을 필요하거나 유익하다.
- 하지만 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을 명심해야 한다.
- 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
// Copyright (C) 2003, 2004, 2005 by Object Mentor, Inc. All rights reserved.
- 기본적인 정보를 주석으로 제공하면 편리하다.
하지만 가능하다면, 함수 이름에 정보를 담는 편이 더 좋다.
또는 특정 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔하겠다.
// good
// 테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance();
// very good
protected abstract Responder responderBeingTested();
- 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
// 옳은 유형이므로 정렬 순위가 더 높다.
// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
- 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
assertTrue(a.compareTo(a) == 0); // a == a
- 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
// SimpleDataFormat은 스레드에 안전하지 못하다. 따라서 각 인스턴스를 독립적으로 생성해야 한다.
- '앞으로 할 일'을 //TODO 주석으로 남겨두면 편하다.
TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
// TODO-MdM 현재 필요하지 않다.
// 체크아웃 모델을 도입하면 함수가 필요 없다.
// 더 이상 필요 없는 기능을 삭제해달라는 알림
// 누군가에게 문제를 봐달라는 요청
// 더 좋은 이름을 떠올려달라는 부탁
// 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의
- 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다.
// 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.
// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.
/**
* @filename : MemberServiceImpl.java
* @description : 멤버 구현체
* @author : 가가
*/
나쁜 주석
- 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등
프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
- 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다.
주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.
// bad
// 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
// good
// 속성 파일이 없다면 loadProperties.load가 파일을 읽어 들이기 전에 모두 기본값으로부터 읽어 들였다는 의미다.
- 코드를 정당화하는 주석도 아니고, 의도나 근거를 설명하는 주석도 아니고
주석이 같은 코드 내용을 그대로 중복한다면 코드보다 주석을 읽는 시간이 더 오래 걸린다.
// bad
// 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 close");
}
}
/**
* 컨테이너와 관련된 Loader 구현
*/
protected Loader loader = null;
- 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게 주석을 달지 못하여 오해할 여지가 생길 수 있다.
- 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은
코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.
- 소스 코드 관리 시스템으로 인해 모듈 첫머리에 변경 이력을 기록하고 관리하는 관계가 필요 없으므로 완전히 제거한다.
- 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석은 개발자가 주석을 무시하는 습관에 빠지도록 한다.
- Javadocs 문서를 제공해야 한다는 잘못된 욕심으로 잡음이 탄생할 수 있다.
- 함수나 변수로 표현할 수 있다면 주석이 필요하지 않도록 코드를 개선하는 편이 더 좋다.
// bad
// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))
// good
ArrayList moduleDependees = smodule.getDependSubsystems();
String ourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))
- 소스 파일에서 특정 위치를 표시하는 배너는 너무 자주 사용하지 않는다면 눈에 띄어 주의를 환기하므로
반드시 필요할 때만, 아주 드물게 사용하는 것이 좋으며 남용할 경우 독자가 흔한 잡음으로 여겨 무시하게 된다.
// Actions ///////////////////////////
- 중첩이 심하고 장황한 함수의 닫는 괄호에 특수한 주석을 달아놓는 것을 잡음일 뿐이므로 함수를 줄이려 시도하자.
try {
while () {
...
...
...
...
...
} // while
...
...
...
...
...
} // try
- 소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 기억하므로 저자 이름으로 코드를 오염시킬 필요가 없다.
- 소스 코드 관리 시스템은 코드를 기억해주므로 주석으로 코드를 처리하지 말고 그냥 코드를 삭제하라.
- 소스 코드에서 HTML 주석은 혐오 그 자체이며 편집기/IDE에서조차 읽기가 어렵다.
- 주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
- 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
- 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. 주석 자체가 다시 설명을 요구하면 안 된다.
- 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
- 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.
