[Clean Code]클린코드_4_주석

잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거없는 주석은 코드를 이해하기 어렵게 만든다.

오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다. 사실상주석은 기껏해야 필요악이다.

우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 전혀 필요하지 않을 것이다. 우리는 코드로 의도를 표현하지 못해, 그러니까 "실패"를 만회하기 위해 주석을 사용한다. 주석은 언제나 실패를 의미한다. 때때로 주석없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다.

프로그래머들이 주석을 엄격하게 관리해야 한다고, 그래서 복구성과 관련성과 정확성이 언제나 높아야 한다고 주장할지도 모르겠다. 하지만 차라리 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요없는 방향으로 에너지를 쏟는 것을 추천한다. 코드만이 정확한 정보를 제공하는 유일한 출처이다. 그러므로 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

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

코드에 주석을 추가하는 일방적인 이유는, 코드 품질이 나쁘기 때문이다. 지저분한 모듈이라는 사실을 자각한다. 따라서 '주석을 달아야겠다'라는 생각이 아니라 '코드를 정리해야겠다'라는 생각을 해야한다.

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

 

 

[코드로 의도를 표현해라 ]

확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다. 이 때 주석을 달기보다는 함수로 만들어 코드로 표현할 수 있나 생각해보자.

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

라고 표현하는거 보다는

if (employee.isEligibleForFullBenefits())

 

 

 

[ 좋은 주석 ]

어떤 주석은 필요하거나 유익하다. 다음은 "글자 값"을 한다고 생각하는 주석 몇가지이다.

하지만 정말로 좋은 주석은 주석을 달지 않을 방법을 찾아낸 주석이라는 것을 명심해야한다.

-법적인 주석

때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다. 예를 들어, 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.

 

-정보를 제공하는 주석

때로는 기본적인 정보를 주석으로 제공하면 편리하다.

//테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance();

때로 위와 같이 주석이 유용하다 할지라도, 함수 이름에 정보를 담는 편이 좋다.

 

-의도를 설명하는, 의미를 명료하게 밝히는 주석

때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다. 또한 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다. 일반적으로는 인수나 반환값자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.

-결과를 경고하는 주석

때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.

//여유 시간이 충분하지 않다면 실행하지 마십시오.
(..코드)


//SimpleDataFormat은 스레드에 안전하지 못하다.
//따라서 각 인스턴스를 독립적으로 생성해야한다.
(...코드)

 

-TODO주석

때로는 '앞으로 할 일'을 //TODO주석으로 남겨두면 편하다. TODO주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다. (ex) 더 이상 필요 없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청 등등) 하지만 어떤 용도로 사용하든 시스템에 나쁜 코드를 남겨놓는 핑계가 되어서는 안된다.  TODO로 떡칠한 코드는 바람직하지 않다. 그러므로 주기적으로 TODO주석을 점검해, 없애도 괜찮은 주석은 없애라.

 

-중요성을 강조하는 주석

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

 

-공개 API에서 Javadocs

 

 

[ 나쁜 주석 ]

대다수 주석이 이 범주에 속한다. 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.

 

-주절거리는 주석

주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다. 이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트만 낭비할 뿐이다.

 

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

 

-오해할 여지가 있는 주석

 

-의무적으로 다는 주석

 

-이력을 기록하는 주석

 

-있으나 마나 한 주석

 

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

 

-위치를 표시하는 주석

 

-닫는 괄호에 다는 주석

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

 

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

 

-주석으로 처리한 코드

 

-HTML 주석

 

-전역 정보

 

-너무 많은 정보

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

 

-모호한 관계

주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.

 

-함수 헤더

짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.

 

-비공개 코드에서 Javadocs