오늘 읽은 범위

• 📕4장. 주석

책에서 기억하고 싶은 내용

• 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. (p.68)
• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다. 부정확한 주석은 독자를 현혹하고 오도한다.(p.69)
• TODO 주석
  • 앞으로 할일을 TODO 주석으로 남겨두면 편리하다.
  • TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다. (p.74)
• 닫는 괄호에 다는 주석
  • 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자 (p.85)
• 전역 정보
  • 주석을 달아야 한다면 근처에 있는 코드만 기술하라. (p.89)

소감 및 생각

• 업무시 함수명 위에 주석을 무조건 다는 사수와 일한적이 있었다. 그 당시에는 그게 상당히 멋있어 보였고, 무조건적으로 필요하다고 생각되어 나도 꼭 저렇게 정리를 하면서 코드를 짜야겠다고 생각을 하고 실천을 옮긴적도 있었다. 하지만 이 책을 읽고나서 최대한 주석을 달지 않고 메소드명 또는 변수명만 보고 어떤 역할을 하는지 알 수 있게 하는 연습이 더 중요하다는것을 깨달았다.

궁금한 내용 | 잘 이해되지 않는 내용