개발자 99% 커뮤니티에서 수다 떨어요!
오늘 TIL 3줄 요약
나쁜 코드에 주석을 달지 마라. 새로 짜라!
정말 주석이 아니면 해결이 안 될 때 주석을 달도록 한다.
주석이 아닌 코드로 대다수 의도를 표현할 수 있다.
TIL (Today I Learned) 날짜
2022. 04. 29
오늘 읽은 범위
4장. 주석
책에서 기억하고 싶은 내용을 써보세요.
경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다.
주석은 기껏해야 필요악이다.
프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하다.
주석은 나쁜 코드를 보완하지 못한다.
코드로 의도를 표현하라!
좋은 주석: 법적인 주석, 정보를 제공하는 주석, 의도를 설명하는 주석, 의미를 명료하게 밝히는 주석, 결과를 경고하는 주석, 중요성을 강조하는 주석 등
나쁜 주석: (대다수 주석이 이 범주에 속한다. ) 주절거리는 주석, 같은 이야기를 중복하는 주석, 오해할 여지가 있는 주석, 의무적으로 다는 주석, 이력을 기록하는 주석, 있으나 마나 한 주석, 무서운 잡음, (함수나 변수로 표현할 수 있다면 주석을 달지 마라! ),
위치를 표시하는 주석, 공로를 돌리거나 저자를 표시하는 주석, HTML 주석, 너무 많은 정보, 모호한 관계 등
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
주석을 달 때에는 정말 주석이 아니면 안 되는 지, 코드로 의도를 표현할 수 없는 지 한 번 더 고민하자!
오늘 읽은 다른사람의 TIL
justin님의 TIL (https://nomadcoders.co/community/thread/4844)