오늘 TIL 3줄 요약
- 주석을 달 필요하게 없게 하는게 가장 중요하다.
- 좋은 주석은 올바르고 의미 있는 정보를 전달한다.
- 나쁜 주석은 있어봤자 도움을 안준다.
TIL (Today I Learned) 날짜
오늘 읽은 범위
책에서 기억하고 싶은 내용을 써보세요.
좋은 주석
주석은 ‘순수하게 선하지’ 못하다.
정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석
- 법적인 주석
- 정보를 제공하는 주석
- 의도를 설망하는 주석
- 의미를 명료하게 밝히는 주석
- 결과를 경고하는 주석
- TODO 주석
- 중요성을 강조하는 주석
- 공개 API에서 Javadocs
나쁜 주석
일반적으로 대다수의 주석은 허술한 코드를 지탱하거나,
엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등
프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
- 주절거리는 주석
- 같은 이야기를 중복하는 주석
- 오해할 여지가 있는 주석
- 의무적으로 다는 주석
- 있으나 마나 한 주석
- 무서운 잡음
- 함수나 변수로 표현할 수 있다면 주석을 달지 마라
- 위치를 표시하는 주석
- 닫는 괄호에 다는 주석
- 공로를 돌리거나 저자를 표시하는 주석
- 주석으로 처리한 코드
- HTML 주석
- 전역 정보
- 너무 많은 정보
- 모호한 관계
- 함수 헤더
- 비공개 코드에서 Javadocs
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
- 코드에서 방치된 TODO 리스트를 떠올렸습니다.😭
- 주석을 작성할 때 이게 도움이 될지 다시 한번 생각해 봐야겠습니다.
- 의무적으로 단 주석 말고 의도나 의미가 있는 주석 같은 경우
결국 프로그래머가 “이게 도움이 될까?” 한번 더 판단하는게 필요하다 느꼈습니다.
나의 최애 북틸
내가 작성한 TIL을 보면 결국 책에서 부제목을 그대로 옮겨적은거에 불과한거 같은데
세상에는 정리를 잘하는 사람이 많은거 같습니다..
nomadcoder
study
노마드코더
노개북
개발자북클럽
← Previous
Post
Next
Post →