주석은 언제나 실패를 의미한다.

제목 : 클린 코드

저자 : 로버트 C. 마틴

범위 : 4장 주석

 

 

---

 

기억하고 싶은 것

• 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.
• 의도를 표현할 능력이 있다면 주석은 거의 필요하지 않으리라.
• 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!
• 좋은 주석이란? 
  • 법적인 주석
  • 정보를 제공하는 주석 (예 : 추상 메서드가 반환할 값 설명)
    • 그럼에도 가능하다면, 함수 이름에 정보를 담는 편이 좋다.
  • 의도(목적)를 설명하는 주석
  • 의미를 명료하게 밝히는 주석
  • 결과를 경고하는 주석
  • 중요성을 강조하는 주석
• 나쁜 주석이란?
  • 함수나 변수로 표현할 수 있다면 주석을 달지 마라
  • 배너는 눈에 띄며 주의를 환기한다. 그러므로 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.
  • 닫는 괄호에 다는 주석은 잡음일 뿐이다.
  • 주석으로 처리된 코드는 필요가 없다. 그냥 삭제하라.

 

떠오르는 질문

• 주석에 대한 나만의 체크리스트를 만들어 볼 수 있을까? (아래 체크리스트 첨부)

 

체크리스트

✅ 주석 대신 이름을 바꾸어보자.

✅ 주석 대신 클래스나 함수를 추가/삭제 해보자.

✅ 주석은 반드시 코드 위에 달자.

✅ 이 주석이 복잡한 코드를 명료하게 하는가?

✅ 주석외에 다른 표현방법이 없는지 다시 한번 생각해보자.