[클린코드] TIL #5. (4) 주석

jungmin kim·2022년 4월 28일
0

TIL (Today I Learned)

2022.04.28.

오늘 읽은 범위

4장 주석

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

  • 주석이 필요한 상황에 처하면 곰곰히 생각하기 바란다. 상황을 역전해 코드로 의도를 표현할 방법은 없을까??
  • 코드만이 정확한 정보를 제공하는 유일한 출처다.
  • 주석이 코드보다 더 많은 정보를 제공하지 못한다.
  • 주석을 달아야한다면 근처에 있는 코드만 기술하라

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

취업 전 한창 공부할 때, 주석을 거의 강의 필기용으로 적었던 것 같습니다.
주석에 대한 규칙도 전혀 인지하지 못한 채 남발했던 기억이 나네요.
그런데 이번 주석 챕터를 읽으니 별로 좋지 못한 습관이라는 것을 깨닫습니다.
그래서 실무에서 최대한 주석을 안 쓰고 정확한 코드로 표현하려고 노력하게 되는 것 같습니다.
4장 주석의 핵심은 '코드만이 정확한 정보를 제공하는 유일한 출처다.' 이 문장이라고 생각합니다.
아 그리고 임시로 주석처리하는 코드도 많은데, 웬만하면 지양하도록 해야겠습니다.

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

0개의 댓글