개발자 99% 커뮤니티에서 수다 떨어요!
오늘 TIL 3줄 요약
주석은 나쁜 코드를 보완하지 않는다
필요하거나 유익한 주석도 있다
대다수 주석은 허술한 코드를 지탱하거나 엉성한 코드를 변명한다
TIL (Today I Learned) 날짜
2022. 04. 29 ~ 2022. 04. 30
오늘 읽은 범위
4장 주석
책에서 기억하고 싶은 내용을 써보세요.
TODO주석으로 앞으로 할 일, 당장 구현하기 어려운 업무등 남겨두면 편하다
좋은 주석 : 법적인주석, 정보를 제공하는 주석, 의도를 설명하는 주석, 의미를 명료하게 밝히는 주석, 결과를 경고하는 주석, 중요성을 강조하는 주석, 공개API에서 javadocs
나쁜 주석 : 주절거리는 주석, 같은 이야기를 중복하는 주석, 오해할 여지가 있는 주석, 이력을 기록하는 주석, 있으나 마나한 주석, 위치를 표시하는 주석, 닫는 괄호에 다는 주석, 공로를 돌리거나 저자를 표시하는 주석, 주석으로 처리한 코드, HTML주석, 전역정보, 너무 많은 정보
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
주석으로 좋은 예도 몇가지 있지만 나쁜 예가 정말 많았다 이처럼 주석을 최대한 안 쓸수 있도록 코드를 짜야된다고 말하고 있다 나도 책에서 말하는 나쁜주석을 몇번 달아본적이 있다 닫는괄호에 여기까지 for문 while문 아마 코드가 복잡해서 그랬던것 같다 또 주석으로 처리한 코드 이 부분은 코드를 주석처리해놓고 결과를 확인하다가 지우지 못하고 놔둔 경우가 종종 있었던 것 같다 나 또한 시간이 지나면 이걸 왜 주석해놨더라 생각이 들법한 주석처리 코드 앞으로는 나도 다른 사람도 보기 좋은 쓸모없는 주석은 지워야 겠다!
궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
오늘 읽은 다른사람의 TIL