Community

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

← Go back
TIL4. 주석
#clean_code
2년 전
444


TIL (Today I Learned)

2022.02.25

오늘 읽은 범위

4장. 주석

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

  • TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다. 하지만 나쁜 코드를 남겨 놓는 핑계가 되어서는 안된다.

  • 의미없이 주절거리거나 중복되는 주석은 피한다.

  • 함수나 변수로 표현할 수 있다면 주석을 달지 마라. 주석이 필요하지 않도록 코드를 개선하라.

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

  • 주석은 나쁜 코드를 보완하지 못한다. 나도 코드를 고민할 때, 내 코드가 다른이에게 설명되지 못할 것 같을 때 주석을 다는 경우가 있었다. 주석으로 이해시키는건 근본적 해결이 아니며, 더 좋은 코드를 고민해야할 것 같다.

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

  • -