이 장은 좋은 주석과 나쁜 주석에 대한 내용을 다룬다.
주석 개요
잘 달린 주석은 그 어떤 정보보다 유용하다
하지만 사실상 주석은 필요악이다
주석을 사용하는 이유는 코드로 의도를 표현하지 못해, 실패를 만회하기 위해서이다.
주석은 실패를 의미한다.
👉🏻명확하게 코드로써 이해를 시키지 못하였기 때문
책의 저자가 주석을 무시하는 이유는?
거짓말을 하니깐
주석은 오래될수록 코드에서 멀어진다. 프로그래머들이 주석을 유지하고 보수하기에는 현실적으로 불가능하기 때문이다.
코드는 변화하고 진화한다. 불행하게도 주석이 언제나 코드를 따라가지는 않는다. 아니 사실 따라가지 못한다.
좋은 주석도 있지만, 애초에 코드를 작성할 때 주석이 필요 없는 방향으로 에너지를 쏟자.
부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.
부정확한 주석은
- 독자를 현혹하고 오도한다.
- 결코 이뤄지지 않을 기대를 심어준다.
- 더 이상 지킬 필요가 없는 규칙이나 지켜서는 안되는 규칙을 명시한다.
정리하자면, 코드만이 정확한 정보를 제공하는 유일한 출처이다. 간혹 필요하더라도 주석을 가능한 줄이도록 꾸준히 노력해야 한다.
주석은 나쁜 코드를 보완하지 못한다.
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다
표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
👉🏻어수선한 코드를 주석으로 설명하려 노력하기보다는, 그 난장판을 치우려 노력하자.
코드로 의도를 표현하라!
주석을 사용하지 않고도 코드로 의도를 표현할 수 있다
많은 프로그래머들은 코드로 개발 의도를 표현하기에는 한계가 있다고 생각한다.
실제로 그런 케이스들이 많다.
하지만 다음과 같은 두 예제 코드로 인해 개발 의도를 주석보다는 코드로 표현하는 것이 훨씬 깔끔하다는 것을 알 수 있다.
//직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if((employee.flags & HOURLY_FLAG) && (employee.age < 65))
//VS
if(employee.isEligibleForFullBenefits())몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.
👉🏻즉, 함수명을 명확하게 잘 짓는 것이 의도를 표현하는데 도움이 된다.
좋은 주석
다음은 좋은 주석에 대한 설명들이다.
법적인 주석
때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
저작권 정보와 소유권 정보는 필요하고도 타당하다.
//Copyright (C) 2003, 2004, 2005 by Object Mentor, Inc, All rights reserved.
정보를 제공하는 주석
때로는 기본적인 정보를 주석으로 제공하면 편리하다.
//테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance();위와 같은 주석이 용이하더라도, 가능하다면 함수 이름에 정보를 담는 편이 좋다.
함수 이름을 responderBeingTested로 바꾸면 주석이 필요 없어진다.
의도를 설명하는 주석
때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
public int compareTo(Object o){
if(o instanceOf WikiPagePath){
WikiPagePath p = (WikiPagePath) o;
String compressedName = StringUtil.join(names,"");
String compressedArgumentName = StringUtil.join(p.names,"");
return compressedName.compareTo(compressedArgumentName);
}
return 1;// 오른쪽 유형이므로 정렬 순위가 더 높다.
}위와 같이 사용하면 좋은 방법일지는 몰라도 확실히 저자의 의도는 드러난다.
의미를 명확하게 밝히는 주석
때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
일반적으로는 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
그릇된 주석을 달아놓을 위험이 상당히 높다.
항상 더 나은 방법이 없는지 고민하고 정확히 달도록 각별히 주의한다.
결과를 경고하는 주석
때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
다음 예제들로 확인하는 것만으로도 명확하게 알 수 있다.
//여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile(){
writeLinesToFile(100000000);
...
}요즘에는 @Ignore 어노테이션을 붙여 테스트 케이스를 꺼버리는 방법을 택한다.
JUnit4가 나오기 이전에는 메소드 이름 앞에 _ 기호를 붙이는 방법이 @Ignore 어노테이션을 대신하는 관례였다.
다음 주석이 아주 적절한 예제이다.
public static SimpleDateFormat makeStandardHttpDateFormat(){
//simpleDateFormat은 스레드에 안전하지 못하다.
//따라서 각 인스턴스를 독립적으로 생성해야 한다.
SimpleDateFormat df = new SimpleDateFormat("...");
df.setTimeZone(TimeZone.getTimeZone("GMT");
return df;
}
TODO 주석
때로는 '앞으로 할 일'을 //TODO 주석으로 남겨두면 편하다.
다음은 함수를 구현하지 않은 이유와 미래 모습을 //TODO 주석으로 설명한 예제다.
//TODO-MdM 현재 필요하지 않다.
//체크아웃 모델을 도입하면 함수가 필요 없다.
protected VersionInfo makeVersion() throws Exception{
return null;
}TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
알림, 요청, 부탁, 주의 등 다양하게 사용될 수 있지만 중요한 점은 시스템에 나쁜 코드를 남겨놓는 핑계가 되면 안된다는 점이다.
중요성을 강조하는 주석
자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다.
예를 들어, 다음과 같이 사용될 수 있다.
String listItemContent = mathc.group(3).trim();
//여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.
//문자열에서 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.
new ListItemWidget(this, listItemContent, this.level+1);
return buildList(text.substring(match.end()));
공개 API에서 Javadocs
설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다. 표준 자바 라이브러리에서 사용한 Javadocs가 좋은 예다. Javadocs가 없다면 자바 프로그램을 짜기가 어렵다.
공개 API를 구현한다면 반드시 훌륭한 javadocs를 작성한다.
나쁜 주석
대다수 주석이 이 범주에 속한다. 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
주절거리는 주석
특별한 이유 없이 의무감으로 마지못해 주석을 단다면 전적으로 시간낭비다. 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.
또한 주석에 대하여 명확한 인과 관계, 이해 관계가 없는 경우에, 그 주석을 해석하기 위해 다른 사람들은 앞 뒤 코드를 확인해야만 할 것이;다. 이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트만 낭비할 뿐이다.
같은 이야기를 중복하는 주석
'쓸데 없는 친절은 오히려 독이다'라고 정리할 수 있다.
헤더에 달린 주석이 같은 코드 내용을 그래도 중복하는 경우, 코드보다 주석이 더 많은 정보를 담으려 하는 경우 와 같이 같은 이야기를 중복하는 주석은 코드를 더 읽기 어렵게 만든다. 실제로 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다.
오해할 여지가 있는 주석
때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다.
코드보다 읽기도 어려운 주석에 담긴 '살짝 잘못된 정보'로 인해 프로그래머는 주석이 없을 때보다 더 어려움을 겪기도 한다.
의무적으로 다는 주석
모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야한다는 규칙은 어리석기 그지없다.
오히려 코드만 헷갈리게 만들며, 거짓말할 가능성을 높이며, 잘못된 정보를 제공할 여지만 만든다.
이력을 기록하는 주석
때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가한다.
일종의 로그가 되는 셈이다.
이러한 방식은 소스 코드 관리 시스템이 없을 때나 하던 관례나 트랜드였다. 이제는 혼란만 가중할 뿐이다.
완전히 제거하는 편이 낫다.
있으나 마나 한 주석
때때로 있으나 마나 한 주석을 접한다. 쉽게 말해, 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
쓸데 없거나 중복적인 주석은 개발자가 오히려 주석을 무시하게 만드는 습관을 만든다.
무서운 잡음
때로는 Javadoc도 잡음이다.
단지 문서를 제공해야 한다는 잘못된 욕심으로 작성된 Javadoc은 잡음이 될 뿐이다.
함수나 변수로 표현할 수 있다면 주석을 달지 마라
조건 반복문 안에 복잡한 코드가 들어가고 이를 설명하는 주석이 달린다면,
반대로 명확한 함수명을 가진 함수로 대체하고 주석을 없애자.
위치를 표시하는 주석
때때로 프로그래머는 소스파일에서 특정 위치를 표시하려 주석을 사용한다.
//Actions /////
극히 드물지만 위와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있긴 하다. 하지만 일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야 마땅하다. 특히 뒷부분에 슬래시로 이어지는 잡음은 제거하는 편이 낫다.
닫는 괄호에 다는 주석
때로는 프로그래머들이 닫는 괄호에 특수한 주석을 달아놓는다.
중첩이 심하고 장황한 함수라면 의미가 있을지 모르지만 우리가 추구하는 클린 코드 안에서는 작고 캡셜화된 함수에선 잡음일 뿐이다.
그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 노력하자.
공로를 돌리거나 저자를 표시하는 주석
소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 잘 기억하고 기록한다.
저자 이름으로 코드를 오염시킬 필요가 없다. 주석이 있으면 다른 사람들이 코드에 관해 누구한테 물어볼지 아니깐 유용하다고 느껴질 수 있다만, 현실적으로 이러한 주석은 그냥 오랫동나 코드에 방치되어 점차 부정확하고 쓸모없는 정보로 변하기 쉽다.
즉, 위와 같은 저자 표시 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.
주석으로 처리한 코드
주석으로 처리한 코드만큼 밉살스러운 관행이 없다.
주석으로 처리된 코드는 다른 사람들이 지우기 주저한다. 이유가 있어 남겨놓았으리라고 생각하기 때문이다.
쓸모 없는 코드가 차근차근 쌓이게 된다.
절대 하지말자
HTML 주석
소스코드에서 HTML 주석은 혐오 그 자체다.
HTML 주석은 편집기/IDE 에서조차 읽기가 어렵다. 도구로 주석을 뽑아 웹 페이지에 올릴 작정이라면 주석에 HTML 태그를 삽입해야 하는 책임은 프로그래머가 아니라 도구가 져야한다.
이 또한 그냥 HTML 주석은 남기지 말자.
전역 정보
주석을 달아야 한다면 근처에 있는 코드만 기술하라.
코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
너무 많은 정보
주석에다 흥미로운 역사나 관련없는 정보를 장황하게 늘어놓지 마라.
주석으로다가 코드에 대한 개념이나 참조문헌, 설명 등을 장황하게 쓸 필요가 없다는 것이다.
모호한 관계
주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
이왕 주석을 달았다면 적어도 독자가 주석과 코드를 읽어보고 무슨 소린지 알아야 하지 않나...
함수 헤더
짧은 함수는 긴 설명이 필요 없다.
짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
비공개 코드에서 Javadocs
공개 API에서는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.
시스템 내부에 속한 클래스와 함수에 javadocs를 생성할 필요는 없다.
유용하지 않을 뿐만 아니라 Javadocs 주석이 요구하는 형식으로 인해 코드만 보기 싫고 산만해질 뿐이다.
정리
개인적으로 이번 챕터를 정리하면서 반복적으로 느낄 수 있었던 포인트는 다음과 같다.
- 주석....필요한 경우에만 쓰되 간단하고 명확하게 쓰자
- 주석 사용하는 것보다는 함수 및 모듈을 최소화시키고 최소화 시키자.
- 주석은 쓰일 곳보다 안쓰일 곳이 더 많다.
- 코드로써 최대한 표현하고 그럼에도 한계가 있을 때만 주석을 사용하도록 하자.
위와 같이 정리가 되었지만, 이번 챕터의 저자의 강한 필력은 주석은....사용하지 말자...였던 것으로 받아들여진다.
주석 사용을 최소화하자!
해당 포스팅 내용은 책 'Clean Code - Robert C. Martin' 출처로 합니다.
'개발 저서 > 클린 코드(Clean Code)' 카테고리의 다른 글
| 클린 코드 6 ~ 18장 - Reference Link (0) | 2022.09.26 |
|---|---|
| 클린 코드 5장 - 형식 (0) | 2022.01.25 |
| 클린 코드 3장 - 함수 (0) | 2022.01.09 |
| 클린 코드 2장 - 의미 있는 이름 (0) | 2022.01.02 |
| 클린 코드 1장 - 깨끗한 코드 (0) | 2022.01.02 |
