[CLEAN CODE] 주석

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

코드에 주석을 추가하는 이유는 코드 품질이 나쁘기 때문이다.
자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!

코드로 의도를 표현하라!

코드는 의도를 설명하기는 훌륭한 수단이다.

좋은 주석

법적인 주석

각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보

정보를 제공하는 주석

메서드가 반환할 값을 설명, 정규표현식이 시각과 날짜를 뜻한다고 설명 등

의도를 설명하는 주석

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

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

인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용

결과를 경고하는 주석

다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용
@Ignore 속성을 이용

TODO 주석

• 프로그래머가 당장 구현하기 어려운 업무를 기술
• 더 이상 필요 없는 기능을 삭제하라는 알림
• 누군가에게 문제를 봐달라는 요청
• 더 좋은 이름을 떠올려달라는 부탁
• 앞으로 발생할 이벤트에 맞춰 코드를 고치하는 주의

중요성을 강조하는 주석

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

공개 API에서 Javadocs

설명이 잘 된 공개 API는 유용하지만, 그릇된 정보를 전달할 가능성이 존재한다.

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

나쁜 주석

주절거리는 주석

특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 시간낭비다.

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

주석이 코드 내용을 그대로 서술한 것이면 코드보다 주석을 읽는 시간에 시간을 허비할 수 있다.
쓸모없고 중복된 Javadocs는 코드만 지저분하고 정신 없게 만든다.

오해할 여지가 있는 주석

주석에 담긴 '살짝 잘못된 정보'로 인해 오해할 여지가 있다.

의무적으로 다는 주석

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

이력을 기록하는 주석

예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했으나,
소스 코드 관리 시스템이 있는 현재는 혼란만 가중하므로 제거하는 편이 좋다.

있으나 마나 한 주석

너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석

무서운 잡음

때로는 Javadocs도 잡음이다.

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

• Before

  // 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
  if (smoudle.getDependSubsystems().contains(subSysMod.getSubSystem())

• After

  ArrayList moduleDependees = smodule.getDependSubsystems();
  String ourSubSystem = subSysMod.getSubSystem();
  if(moduleDependees.contains(ourSubSystem))

위치를 표시하는 주석

때때로 소스 파일에서 특정 위치를 표시하려 주석을 사용한다.
// Actions //////////////////////////////////
위와 같은 배너 아래에 특정 기능을 모아놓으면 유용한 경우도 있지만 가독성을 낮춘다.
너무 자주 사용하지 않는다면 배너는 눈에 띄어 아주 드물게 사용하는 편이 좋다.

닫는 괄호에 다는 주석

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

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

○○가 추가함

코드에 관해 누구한테 물어볼지 아니까 유용하다 여길지도 모르겠지만 그냥 오랫동안 코드에 방치되어 부정확하고 쓸모없는 정보로 변하기 쉽다.

주석으로 처리한 코드

주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.
소스 코드 관리 시스템이 있는 지금은 주석으로 처리할 필요 없이 삭제해라.

HTML 주석

/**
 *
 * 적합성 테스트를 수행하기 위한 과업
 * <p/>
 * <pre>
 * 용법:
 * &lt;taskdef name=&quot;
 * 이하 생략
 * </pre>
 **/

HTML 주석은 편집기/IDE에서조차 읽기가 어렵다.

전역 정보

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

너무 많은 정보

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

모호한 관계

주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
이왕 주석을 달았다면 적어도 독자가 주석과 코드를 읽어보고 무슨 소린지 알아야 한다.

함수 헤더

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

비공개 코드에서 Javadics

공개하지 않을 코드라면 Javadocs는 쓸모가 없다.