4. 주석

[클린코드 - http://www.yes24.com/Product/Goods/11681152]

 

• 잘 달린 주석은 그 어떤 정보보다 유용하다
• 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다
• 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다

 

• 주석은 언제나 실패를 의미한다
  • 코드로 의도를 표현하지 못해 실패를 만회하기 위해 주석을 사용함
• 주석은 거짓말을 한다
  • 주석을 유지보수하기는 현실적으로 불가능이라 오래될수록 코드에서 멀어진다
• 주석보다 코드에 집중하여 주석이 필요 없는 방향으로 노력하는게 낫다
• 주석을 가능한 줄이도록 꾸준히 노력해야 한다

 

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

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

 

코드로 의도를 표현하라!

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

 

좋은 주석

• 정말로 좋은 주석은 주석을 달지 않을 방법을 찾아낸 주석이다!
• 법적인 주석
  • 저작권 정보, 소유권 정보, 표준 라이센스 등
• 정보를 제공하는 주석
  • 때로 기본적인 정보를 주석으로 제공하면 편리하다
    • 그렇지만 함수 이름에 정보를 담는 편이 더 좋다
• 의도를 설명하는 주석
  • 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다
• 의미를 명료하게 밝히는 주석
  • 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다
  • 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다
• 결과를 경고하는 주석
  • 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용
• TODO 주석
  • TODO 주석 : 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술
  • 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애는게 좋다
• 중요성을 강조하는 주석
• 공개 API에서 Javadocs

 

나쁜 주석

• 대대수의 주석이 이 범주에 속한다
• 주절거리는 주석
  • 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력해야 한다
• 같은 이야기를 중복하는 주석
  • 같은 코드 내용을 그대로 중복하는 주석은 좋지 않다
  • 코드보다 읽기 어렵고 부정확하다
• 오해할 여지가 있는 주석
• 의무적으로 다는 주석
  • 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지 없다
• 이력을 기록하는 주석
  • 소스 코드 관리 시스템이 없을 때는 바람직했으나 이제는 혼란만 가중하므로 완전히 제거하는 편이 좋다
• 있으나 마나 한 주석
  • 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석
  • 개발자를 주석을 무시하는 습관에 빠지게 한다
• 무서운 잡음
  • 때로는 Javadocs도 잡음이다
• 함수나 변수로 표현할 수 있다면 주석을 달지 마라
  • 주석이 필요하지 않도록 코드를 개선하는 것이 좋다
• 위치를 표시하는 주석
  • 배너는 눈에 띄며 주의를 환기하므로 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다
• 닫는 괄호에 다는 주석
• 공로를 돌리거나 저자를 표시하는 주석
  • 소스 코드 관리 시스템에 저장하는 편이 좋다
• 주석으로 처리한 코드
  • 소스 코드 관리 시스템이 기억해주니까 삭제하자
• HTML 주석
• 전역 정보
  • 주석을 달아야 한다면 근처에 있는 코드만 기술하라
  • 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라
• 너무 많은 정보
  • 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라
• 모호한 관계
  • 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다
• 함수 헤더
  • 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다
• 비공개 코드에서 Javadocs
  • 공개하지 않을 코드라면 Javadocs는 쓸모가 없다