📚 오늘 읽은 범위: 4장 주석
📖 책에서 기억하고 싶은 내용을 써보세요.
• 사실상 주식은 기껏해야 필요악이다... 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. (p.68)
• 좋은 주석 (p.70~75)
- 법적인 주석: 때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
- 의도를 설명하는 주석: 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
- 의미를 명료하게 밝히는 주석: 때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
- 결과를 경고하는 주석: 때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
- TODO 주석: 때로는 '앞으로 할 일'을 /TODO 주석으로 남겨두면 편하다.
🙇♂️ 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요.
• 저자가 좋다고 생각하는 주석조차도 모두 첫구절이 "때로는" 또는 "때때로"로 시작한다. 좋은 주석조차도 왠만하면 쓰지 않는게 좋다는 의미일 것이다. 주석은 "좋은 주석일지라도" 기껏해야 필요악이다!!
🤷♂️ 궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
• Javadoc: JAVA 소스코드에서 API 문서를 html 태그형식으로 작성하게 해주는 도구
JavaDoc 주석 알고쓰자!
주석작성할때 나름대로 다음 사람에게 인계하는 마음으로 열심히 나름대로 달아놨는데,최근에 읽은 클린코드책에서는 쓸데없는 주석은 안 다는게 낫다는 말에 주석은 어떻게 써야 잘 쓸수 있
velog.io
댓글