클린코드 4장 : 주석

4장 : 주석

주석은 오래될수록 코드에서 멀어진다. 프로그래머들이 주석을 유지하고 보수하는것은 현실적으로 어렵다.

또한, 코드는 변화하고 옮겨지면서 주석이 코드를 언제나 따라가지는 않는다.

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다. 부정확한 주석은 독자를 현혹하고 오도한다.

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

코드에 주석을 추가하는 이유는 코드 품질이 나쁘기 때문이다.

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

주석을 추가하기 위해 애쓰는 것보는 코드를 깨끗하게 관리하는데 시간을 보내라.

코드로 의도를 표현하라.

코드로 대다수의 의도를 표현할 수 있다. 많은 경우 주석으로 달려는 설명을 함수러 만들어 표현해도 충분하다.

좋은 주석

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

법적인 주석

회사가 정립한 구현 표준에 맞춰서 특정 주석을 넣으라고 하는경우

정보를 제공하는 주석

기본적인 정보를 주석으로 제공하면 편리하지만 클래스나 메서드를 이용하여 코드를 옮기면 주석없도록 코드를 수정할 수 있다.

의도를 설명하는 주석

결정에 깔린의도를 설명하는 주석

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

모호한 인수나 반환값에 대해서 의미를 좋게 하는 주석

코드자체를 명로하게 개발하는 것이 좋지만 표준 라이브러리와 같이 변경하기 힘든 코드의 경우 주석을 달면 이해하기 쉬워진다. 하지만 그릇된 주석을 달아놓을 확률이 높기 때문에 더 나은 방법이 없는지 고민하고 코드를 다는것이 좋다.

결과를 경고하는 주석

프로그래머에게 결과를 경고할 목적으로 적는 주석

//여유시간이 충분하지 않다면 실행하지 마십시오
public void bigInput(){
    //큰 파일을 읽어야 하는 테스트
}

 

TODO 주석

앞으로 할 일을 TODO 주석으로 표기하면 편하다. 미래에 구현해야할 모습을 기술한다.
하지만 TODO로 떡칠된 코드는 바람지 하지 않기때문에 주기적으로 TODO를 관리하라.

중요성을 강조하는 주석

대수롭지 않게 보이는 코드의 중요성을 강조하기 위해 주석을 사용할 수 있다.

공개 API에서 Javadocs

공개 API를 구현한다면 반드시 훌륭한 Javadocs를작성하자. 하지만 독자를 오도하게 하거나 주석을 잘못위치 시키는 등 주석을 달때 주의하며 작성한다.

나쁜 주석

대다수의 주석이 이 범주에 속한다.

주절거리는 주석

주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력해야 한다.

try{
....
}
catch(IOException e) {
  //속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
}

이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.

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

코드의 내용을 그대로 중복하는 주석을 달지 말자. 이런경우 코드보다 주석을 읽는 시간이 더 오래걸린다.

오해할 여지가 있는 주석

실제 코드가 동작하는 것과 딱 맞게 엄밀하게 주석을 달지 못하기도 한다.
주석으로 인해 코드를 오해하게 만들어 다른 프로그래머나 자신을 힘들게 할 수 도 있다.

의무적으로 다른 주석

모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 코드를 복잡하게 만들고 잘못된 정보를 제공할 여지를 만들게 된다. 이로인해 잘못된 정보를 제공할 여지만 만들기에 제거하는것이 좋다.

이력을 기록하는 주석

모듈을 편집할 때 모듈 첫머리에 주석을 추가하는 경우가 있다. 이는 과거 버전관리 환경이 없을때는 바람직하였지만 현재는 혼란만 가중하기 때문에 완전히 제거하는것이 좋다.

있으나 마나 한 주석

너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석은 정보를 제공하지 못하기에 제거하는 것이 좋다.

있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하고. 더 낫고 행복한 프로그래머가 되는 지름길이다.

무서운 잡음

유지 관리가 잘 되지 않은 주석을 아무정보도 제공하지 못하고 혼란만 제공한다.

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

주석이 필요하지 않도록 코드를 개선하는 것이 편이 좋다.

위치를 표시하는 주석

// Actions //////////////////////

소스 파일에서 특정 위치를 표시하기 위해 주석 사용하는 경우가 있다. 극히 드물지만 위치를 알려주는 주석 밑에 특정기능을 모아두면 유용한 경우도 있다. 너무 자주 사용하지 않는다면 눈에 띄며 주의를 환기하는 역할을 하기 때문에 필요할 때만, 아주 드물게 사용하는 편이 좋다.

닫는 괄호에 다는 주석

중첩이 심하고 장환한 함수라면 의미가 있을 수도 있지만 우리가 만들려고 목표하는 작은 함수에는 의미가 없다.

닫는 괄호에 주석을 달아야겠다는 생각이 든다면 함수를 줄이려고 시도해야 한다.

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

이런 주석을 오랫동안 코드에 방치되어 쓸모없는 정보로 변하기 쉽다.

위와 같은 정보는 소스 코드 관리 시스템이 저장하는 편이 좋다.

주석으로 처리한 코드

주석으로 처리한 코드만큼 밉살스러운 관행도 드물다. 주석으로 처리한 코드는 이유가 있어서 남겨놨을거라고, 중요하니까 지우면 안 된다고 생각하기 때문에 쓸모없는 코드임에도 제거되지 못하고 점차 쌍혀간다.

과거에는 주석으로 처리한 코드가 유용했지만 현재는 소스코드 관리 시스템이 코드를 기억해주기 때문에 주석으로 처리할 필요가 없다. 잃어버릴 염려는 없다.

HTML 주석

소스코드에서 HTML주석은 혐오 그 자체다. 도구로 주석을 뽑아 웹 페이지에 올릴 작정이라면 주석에 HTML 태그를 삽입해야 하는 책임은 프로그래머가 아니라 도구가 가져야 한다.

전역 정보

주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.

너무 많은 정보

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

독자에게 불 필요하며 불가사의한 정보일 뿐이다.

모호한 관계

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

적어도 독자가 주석과 코드를 통해 무슨소린지 알아야 한다. 주석 자체가 다시 설명을 요구하는 경우 주석을 다시 작성하자.

함수 헤더

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

비공개 코드에서 Javadocs

공개 API는 Javadocs가 유용하지만 공개하지 않은 경우라면 쓸모가 없다.

시스템 내부에 속한 클래스는 작성할 필요가 없고, 유용하지 않을 뿐만 아니라 코드만 보기 어려워지고 산만해진다.