[클린 코드] 4장 주석

주석

잘 달린 주석은 그 어떤 정보보다 유용하다. 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. 주석은 언제나 실패를 의미한다. 때때로 주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다.

코드는 변화하고 진화한다. 일부가 여기서 저기로 옮겨지기도 한다. 조각이 나뉘고 갈라지고 합쳐지면서 괴물로 변한다. 불행하게도 주석은 언제나 코드를 따라가지 않는다. 진실은 언제나 코드에만 존재한다. 그러므로 우리는 주석을 가능한 줄이도록 노력해야 한다.

주석은 나쁜 코드를 보완하지 못한다
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는데 시간을 보내라.

코드로 의도를 표현하라!
코드만으로 의도를 설명하기 어려운 경우가 존재한다. 불행히도 많은 개발자가 이를 코드는 훌룡한 수단이 아니라는 의미로 해석한다.

좋은 주석

• 법적인 주석
  때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다. 소스 파일 첫머리에 들어가는 주석이 반드시 계약 조건이나 법적인 정보일 필요는 없다.

• 정보룰 재공하는 주석
  때로는 기본적인 정보를 주석으로 제공하면 편리하다.
  //테스트 중인 Responder 인스턴스를 반환한다.
  protected abstracted Responder responderInstance();
  예를 들어 이 주석은 추상 메서드가 반환할 값을 설명한다.

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

• 의미를 명료하게 밝히는 주석
  모호한 인수나 반환값은 그 의미를 좋게 표현하면 이해하기 쉬워진다. 일반적으로는 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.

• 결과를 경고하는 주석
  다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.

• TODO 주석
  '앞으로 할일'이라는 의미로 주석으로 남겨두면 편하다. TODO주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.

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

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

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

• 같은 이야기를 중복하는 주석
  헤더에 코드의 진행 내용이 담긴 주석이 있다고 가정해보자. 주석이 같은 코드 내용을 그대로 중복한다. 자칙하면 코드보다 주석을 읽는 시간이 더 오래 걸린다.

• 오해할 여지가 있는 주석
  때로는 의도는 좋았으나 프로그래머가 딱 맞을 정도로ㅗ 엄밀하게는 주석을 달지 못하기도 한다.

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

• 이력을 기록하는 주석
  때로는 사람들은 모듈을 편질할 때마다 모듈 첫머리에 주석을 추가한다. 예전에는 모든 모듈에 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했다. 당시에는 소스 코드 관리 시스템이 없었기 때문이다. 하지만 이제는 혼란만 가중할 뿐이다.

• 있으나 마나 한 주석

• 무서운 잡음
  떄로는 javadocs도 잡음이다. javadocs도 단순히 정보를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음일 뿐이다.

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

• 위치를 표시하는 주석
  때로는 프로그래머가 소스 파일에 특정 위치를 표시하려 주석을 사용한다.

• 닫는 괄호에 다는 주석
  닫는 괄호에 특수한 주석을 달아놓는다. 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화된 함수에는 잡음일 뿐이다.

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

• 주석으로 처리한 코드
  주석으로 처리된 코드는 다른사람들이 지우기를 주저한다. 이유가 있거나 중요해서 남긴거라 생각해 지우면 안된다고 생각한다.

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

• 전역 정보