나쁜 코드에 주석을 달지 마라. 새로 짜라. - 브라이언 W. 커니핸, P.J. 플라우거
주석은 필요악이다. 코드를 통해 개발자의 의도를 모두 표현할 수 있다면 주석이 필요없기 때문이다.
또한, 주석은 시간이 지날수록 부정확해진다. 코드가 다른 곳으로 옮겨질 때, 주석은 함께 옮겨지지 않는 경우가 많기 때문이다.
부정확한 주석은 아예 없는 것보다 못하기 때문에 코드를 깔끔하게 정리하고 표현력을 강화하는 것이 더욱 중요하다.
주석은 나쁜 코드를 보완하지 못한다
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 낮기 때문이다. 이 때는 주석을 달기 보다는 코드를 정리해야 한다.
표현이 깔끔하고 주석이 없는 코드가, 복잡하며 주석이 많은 코드보다 훨씬 좋다.
코드로 의도를 표현하라!
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if((employee.flags & HOURLY_FLAG) && (employee.age > 65))
if(employee.isEligibleForFullBenefits())위의 두 코드 중, 이해가 쉬운 것은 당연하게도 아래 쪽의 코드일 것이다.
코드로 의도를 표현하기 어렵다고 생각하는 경우, 주석으로 달고자 하는 설명을 함수로 표현해도 충분하다.
좋은 주석
몇몇 주석은 필요하거나 유익하다.
법적인 주석
각 소스 파일의 첫 부분에 들어가는 저작권 정보나 소유권 정보 등은 필수적이다.
정보를 제공하는 주석
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile("\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*");위의 코드는 정규표현식에 대한 설명을 나타내고 있다. 이러한 정보를 제공하면 코드를 이해하는데 도움이 될 것이다.
물론 이러한 주석을 다는 것보단 시간과 날짜를 변환하는 클래스를 새롭게 만들어 사용하면 더욱 좋다.
의도를 설명하는 주석
일반적이지 않은 의도를 표현한 코드에는 주석이 있다면, 코드를 이해하는 것을 넘어서 개발자의 의도까지 이해할 수 있다.
의미를 명료하게 밝히는 주석
인수나 반환값이 표준 라이브러리에 속해있거나, 변경하지 못하는 코드의 경우에는 주석을 다는 것이 좋다.
결과를 경고하는 주석
다른 프로그래머에게 결과를 경고할 목적으로 주석을 작성한다.
예를 들어, 테스트 케이스의 실행 결과가 너무 오래 걸릴 때 이를 경고하기 위하여 작성한다. 요즘에는 이럴때는 주석보다는 @Ignore 속성을 이용한다.
TODO 주석ㅈ
앞으로 구현해야 하는 코드를 TODO 주석을 남겨두면 나중에 찾기도 쉽고 다른 사람에게 알리기도 좋다.
중요성을 강조하는 주석
대수롭지 않게 여길 수 있는 부분을 강조하기 위해서 주석을 사용할 수 있다.
공개 API에서 Javadocs
공개 API를 만들 경우, 설명을 잘 해놓으면 유용하고 만족스럽게 사용할 수 있다.
나쁜 주석
대부분의 주석이 나쁜 주석에 해당한다.
주절거리는 주석
남이 시켜서 의미 없이 주석을 다는 것은 주석을 작성하는 사람과, 코드를 읽는 사람 모두에게 시간 낭비이다.
같은 이야기를 중복하는 주석
주석이 코드 내용보다 많은 정보를 제공하지 못하거나, 중복되는 내용이 많은 경우 주석은 코드를 지저분하게 만든다.
오해할 여지가 있는 주석
주석을 작성하는 것은 좋으나, 개발자의 의도대로 작동하지 않는 경우에는 작성한 사람 역시 주석으로 인해 머리가 아플 것이다.
의무적으로 다는 주석
모든 함수 및 변수에 주석을 다는 것은 코드를 복잡하게 만들 뿐이다.
이력을 기록하는 주석
코드를 수정할 때마다, 코드의 첫머리에 주석을 추가하지 말고 버전 관리 시스템을 사용하자.
있으나 마나 한 주석
너무 당연한 사실을 언급하는 주석은 필요가 없다. 오히려 이런 주석을 건너 뛰다가 중요한 주석을 놓칠 수도 있기 때문이다.
// 생성자
public Calendar(){
}
// 월 중 일자
private int dayOfMonth;
// @return 월 중 일자
public int getDayOfMonth(){
return dayOfMonth;
}무서운 잡음
Javadocs에도 쓸모없는 주석이 존재할 수 있으며, 작성자가 정보를 제공하기 위해 의미없이 복붙을 했을 수도 있다.
함수나 변수로 표현할 수 있다면 주석을 달지 마라
주석을 달기 보다는 코드를 알기 쉽게 작성하자.
위치를 표시하는 주석
파일 내에서 특정한 위치를 나타내기 위하여 주석을 사용하는 경우도 있다.
닫는 괄호에 다는 주석
while, try ~ catch 등 블록이 끝나는 괄호 부분에도 주석을 사용하는 경우가 있는데, 구조가 복잡하지 않다면 사용하지 않는 것이 좋다.
공로를 돌리거나 저자를 표시하는 주석
버전 관리 시스템은 누가 코드를 작성했는지 잘 나타낸다. 굳이 주석을 사용하지 말자.
주석으로 처리한 코드
주석으로 처리한 코드는 왜 삭제하지 않았는지 다른 사람이 알 수 없다. 버전 관리 시스템을 사용하면 옛날 코드도 다시 확인할 수 있다.
HTML 주석
소스 코드에서 HTML 주석은 혐오 그 자체다.
전역 정보
주석을 작성하는 부분과 관련 있는 내용만 작성하자.
전역 정보를 주석으로 작성했을 때, 전역 정보가 변하면 다른 곳에 위치한 주석까지 바뀔 것이라는 보장이 없다.
너무 많은 정보
주석에 코드를 설명하는 것 외에 다른 정보를 작성하지 말자.
모호한 관계
주석과 주석이 설명하는 코드는 명백한 관계를 가져야 한다.
/*
* 모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다)
* 그리고 헤더 정보를 위해 200바이트를 더한다.
*/
this.pngBytes = new byte[((this.width + 1) * this.height * 3) + 200];위의 코드에서 필터 바이트가 +1과 *3 중 어느 부분인지, 왜 200을 더하는지 주석만으로는 이해가 어렵다.
함수 헤더
짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석보다 훨씬 좋다.
비공개 코드에서 Javadocs
공개하지 않는 코드에서는 Javadocs를 생성하지 않아도 된다. 오히려 Javadocs가 요구하는 주석 형식으로 인해 코드만 보기 싫어진다.
