오늘 TIL 3줄 요약

• 주석은 기껏해야 필요악이다.

• 실패를 만회하기 위해 주석을 사용한다.

• 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

TIL (Today I Learned) 날짜

2022. 04. 29

오늘 읽은 범위

4장. 주석

책에서 기억하고 싶은 내용을 써보세요.

• 주석은 언제나 실패를 의미한다

• 애초에 주석이 필요없는 방향으로 에너지를 쏟겠다

• 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

• 평소에 TODO 주석을 제외하곤 가급적 주석은 달지 않고 있었는데 이번 장을 읽어보니 좋습 습관이라고 생각한다.(사실은 주석 달기 귀찮아서..😅) 꾸준하게 주석을 가급적 사용하지 않는 방향으로 노력해야겠다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

• Javadoc: java 코드에서 API 문서를 HTML 형식으로 생성해주는 도구

• 비슷한 기능으로 자바스크립트에서는 JSdoc이 있다.