Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
[TIL] Chapter 4. 주석
#clean_code
2년 전
380


TIL (Today I Learned)

2022.02.25

오늘 읽은 범위

4장. 주석

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

  • 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면 주석은 필요하지 않다.

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

  • 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.

  • 이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트만 낭비할 뿐이다.

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

  • 어느 정도 아는 내용이였지만 IDE가 현재만큼 발전되지 않았던 과거에는 주석을 어떤 용도로 사용했었는지 알 수 있어서 재밌었다.

  • 앞서 읽은 2장과 3장 내용을 실천하여 코드만으로 모든 의도가 드러나서 주석이 필요없는 코드를 짜야겠다고 한 번 더 다짐했다.

  • TODO 주석은 팀 내에서도 종종 사용한다. 참고로 vscode에 TODO Highlight 라는 익스텐션이 있는데 주석 표시하고 TODO 혹은 FIXME 라고 적은 부분이 노란색/핑크색으로 하이라이트 되어 유용하니까 혹시 모르시는 분이 계시면 사용해보시는 걸 추천하고 싶다.

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