Community

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

← Go back
TIL 4장 주석.
#clean_code
2년 전
474

오늘 TIL 3줄 요약

<예시>

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

  • 의도는 코드로 설명하려고 노력해야 한다.

  • 그렇다고 모든 주석이 나쁜 것은 아니다.

</예시>

TIL (Today I Learned) 날짜

2022.04.30

오늘 읽은 범위

4장. 주석

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

  • 나쁜 코드에 주석을 달지 마라. 새로 짜라.

  • 일반적으로 주석을 다는 이유는 코드 품질이 좋지 않기 때문에 의도를 보충하기 위해서 단다. 이럴 때는 최대한 주석을 달아야 된다는 생각보다 코드를 정리해야겠다는 생각부터 하는 것이 맞다.

  • 좋은 주석 - 법적인 주석, 정보 제공 주석, 의도 설명 주석, 의미 밝히는 주석, 결과를 경고하는 주석, TODO 주석, 중요성을 강조하는 주석

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

  • 나쁜 주석 설명을 시작할 때, "일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다." 로 시작한다. 뜨끔 했다. 나름 주석을 잘 활용하고 있다고 생각했는데 지금 생각해보면 코딩 실력이 부족해 허술한 코드를 지탱하는 느낌으로 많이 쓰지 않았나 싶다.

  • 사실 처음 코딩을 공부할 때 주석을 많이 달아서 설명을 포함하면 좋다고 들어서 주석을 습관적으로 달고 있다. 좋은 주석의 예로 소개된 TODO나 몇 가지 좋은 주석을 달고 있지만 대다수는 책에서 말해줬 듯이 코딩을 더 명확하게 했으면 필요 없지 않았을까 생각 든다. 이번 단원은 읽으면서 2, 3장을 더 잘 이해해야겠다는 생각이 들게 해줬다.

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

  • 없음

오늘 읽은 다른사람의 TIL

  • 없음