개발자 99% 커뮤니티에서 수다 떨어요!
오늘 TIL 3줄 요약
주석은 나쁜코드를 보완하지 못한다.
주석으로 설명하기보다 코드로 의도를 표현하라.
좋은 주석은 주석을 달지 않을 방법을 찾아낸 주석이다.
TIL (Today I Learned) 날짜
2022-04-29
오늘 읽은 범위
4장. 주석
책에서 기억하고 싶은 내용을 써보세요.
주석은 언제나 실패를 의미한다. 때때로 주석 없이는 자신을 표현할 방법을 찾지못해 할 수 없이 주석을 사용한다.
좋은 주석:
법적인 주석
정보를 제공하는 주석
의도를 설명하는 주석
의미를 명료하게 밝히는 주석
결과를 경고하는 주석
TODO 주석
중요성을 강조하는 주석
같은 이야기를 중복하는 주석은 실제로 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다.
주석을 다는 목적은 코드만으로 설명이 부족해서다.
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
많은 생각이 드는 챕터였다.. 평소에 내가 주석을 다는 방식이 '나쁜 주석'에 해당하는 경우가 여럿 있어서 반성하게 되었다. 제 3자가 내 코드를 읽을 때 도움을 줄 수 있도록 주석을 달 때 고민을 많이 해야할 것 같다!
궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
없음