[CleanCode] 4장 주석

주석

잘 달린 주석을 그 어떤 정보보다 유용하다.

주석을 나쁜 코드를 보완하지 못한다

• 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

코드로 의도를 표현하라

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

좋은 예
if (employee.isEligibleForFullBenefits())

• 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.

좋은 주석

• 정말로 좋은 주석을, 주석을 달지 않을 방법을 찾아낸 주석이다.

법적인 주석

• 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시하였을 때
• 소스파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보

정보를 제공하는 주석

• 추상 메서드가 반환할 값을 설명하는 주석
  • 하지만 함수의 이름을 더 정확하게 작성한다면 이도 필요 없어진다.
• 정규표현식의 형식을 나타내는 주석
  • 이 또한 변환 클래스를 따로 만들어 코드를 옮겨주면 더 깔끔해진다.

의도를 설명하는 주석

• 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명하는 주석

의미를 명료하게 밝히는 주석

• 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
• 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
• 주석이 올바른지 검증하기 쉽지 않기 때문에 주의해야 한다.

결과를 경고하는 주석

• 특정 테스트 케이스를 꺼야하는 이유를 설명하는 주석

TODO 주석

• TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
• 하지만 어떤 용도로 사용하든 시스템에 나쁜 코드를 남겨놓는 핑계가 되어서는 안 된다.

중요성을 강조하는 주석

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

공개 API에서 Javadocs

• 설명이 잘 된 공개 API는 유용하다.
• 공개 API를 구현한다면 반드시 훌륭한 Javadocs를 작성한다.

나쁜 주석

주절거리는 주석

• 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 시간낭비이다.
• 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.

같은 이야기를 반복하는 주석

• 같은 코드 내용을 중복하는 주석을 자칫하면 코드보다 주석을 읽는 시간이 더 오래 걸린다.

의무적으로 다는 주석

• 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석다.
• 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼돈과 무질서를 초래한다.

이력을 기록하는 주석

• 과거에는 변경 리겨을 기록하는 관리하는 관례가 바람직했다.
• 하지만 현재는 소스 코드 관리 시스템이 존재하므로 제거하는 편이 좋다.

있으나 마나 한 주석

• ex) 기본 생성자, 월 중 일자 등…
• 있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하자.

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

• 주석이 필요하지 않도록 코드를 개선하자.

닫는 괄호에 다는 주석

try {
    while() {

    } //while
} //try

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

주석으로 처리한 코드

• 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.
• 소스 코드 관리 시스템을 이용하기 때문에 더 이상 주석으로 처리할 필요가 없다.

전역 정보

• 주석을 달아야 한다면 근처에 있는 코드만 기술하자.

너무 많은 정보

• 주석에 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 말자.

모호한 관계

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

함수 헤더

• 짧은 함수는 긴 설명이 필요 없다.
• 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.

비공개 코드에서 Javadocs

• 공개 API는 Javadocs가 유용하지만 공개하질 않을 코드라면 Javadocs는 쓸모가 없다.
• 유용하지 않고, Javadocs 주석이 요구하는 형식으로 인해 코드만 보기 싫고 산만해진다.