TIL (Today I Learned)

• 2022.02.25

오늘 읽은 범위

• 4장 주석

책에서 기억하고 싶은 내용을 써보세요.

• 나쁜 코드에 주석을 달지 마라. 새로 짜라.
  - 브라이언 W. 커니핸, P.J.플라우거

• 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 주석을 가능한 줄이도록 노력해야한다.

• 주석은 나쁜 코드를 보안하지 못한다.

• 코드로 의도를 표현하라

• 좋은 주석
  법적인 주석
  정보를 제공하는 주석
  의도를 설명하는 주석
  의미를 명료하게 밝히는 주석
  결과를 경고하는 주석
  TODO 주석
  중요성을 강조하는 주석
  공개 API에서 Javadocs

• 나쁜 주석
  주절거리는 주석
  같은 이야기를 중복하는 주석
  오해할 여지가 있는 주석
  의무적으로 다는 주석
  이력을 기록하는 주석
  있으나 마나 한 주석
  무서운 잡음
  위치를 표시하는 주석
  닫는 괄호에 다는 주석
  공로를 돌리거나 저자를 표시하는 주석
  주석으로 처리한 코드
  HTML 주석
  전역 정보
  너무 많은 정보
  모호한 관계
  함수 헤더
  비공개 코드에서 Javadocs

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

• 어떤 주석이 좋은 주석인지 또 어떤 주석이 나쁜 주석인지 알게 되었고
  앞으로 코드에서 최대한 주석을 없애도록 노력하겠지만 좋은 주석이 존재한다는 걸 생각하면서 작성해야겠다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

• NULL