주석

주석은 필요악이다.

주석은 언제나 실패를 의미한다.
프로그래밍 언어 자체가 표현력이 풍부하다면 주석은 필요하지 않다.
코드는 변화하고 진화하고 이동하는 반면 이에 맞게 주석을 유지 보수하기란 현실적으로 불가능하다.
그러므로 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

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

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

코드로 의도를 표현하라!

주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

좋은 주석

유익한 주석도 존재한다.

• 법적인 주석
  회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.

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

• 의도를 설명하는 주석
  결정에 깔린 의도까지 설명한다.

• 의미를 명료하게 밝히는 주석
  모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.

• 결과를 경고하는 주석

• TODO주석
  당장 구현하기 어려운 업무를 기술한다.

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

나쁜 주석

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

• 주절거리는 주석
  이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.
  그런 주석은 바이트만 낭비할 뿐이다.

• 같은 이야기를 중복하는 주석
  주석이 코드보다 더 많은 정보를 제공하지 못하고, 독자가 함수를 대충 이애하고 넘어가게 만든다.

• 오해할 여지가 있는 주석

• 의무적으로 다는 주석
  모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.

• 이력을 기록하는 주석
  예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했다.
  하지만 이제 소스 코드 관리 시스템이 있으니 제거하는 것이 좋다.

• 있으나 마나 한 주석
  너무 당연한 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠트린다.

• 무서운 잡음
  함수나 변수로 표현할 수 있다면 주석을 달지 마라
  위치를 표시하는 주석 ////ACTIONS ///////
  아주 드물게 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있다.
  하지만 자주 사용하지 말자. 잡음으로 여긴다.

• 닫는 괄호에 다는 주석
  닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.

• 공로를 돌리거나 저자를 표시하는 주석
  소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다.

• 주석으로 처리한 코드
  소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다.
  이제는 주석으로 처리할 필요가 없다.
  그냥 코드를 삭제하라. 잃어버릴 염려는 없다.

• HTML주석

• 전역정보
  코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.

• 너무 많은 정보

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

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

• 비공개 코드에서 Javadocs