🔖 오늘 읽은 범위 : 4장. 주석 (p.68 ~ 81)
<aside> 😃 책에서 기억하고 싶은 내용을 써보세요.
</aside>
주석은 언제나 실패를 의미한다. → 거짓말을 하니까.
<aside> 💡 [좋은 주석]
법적인 주석 (저작권, 소유권 정보 등)
의도를 설명하는 주석 (구현의 이해를 도와줌)
결과를 경고하는 주석 (속도가 오래 걸리는 테스트 케이스 같은 경우)
TODO 주석
중요성을 강조하는 주석
</aside>
<aside> 💡 [나쁜 주석]
같은 이야기를 반복하는 주석 (코드를 굳이 설명한다거나..)
의무적으로 다는 주석 (javadocs같이 메서드와 파라미터를 설명하는 주석은 굳이 전부 달 필요 없다. 아주 오래전에 소스코드 관리 시스템이 없을 경우에 사용하던 관례이나 지금은 필요 없기 때문이다.)
</aside>
<aside> 🤔 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
</aside>
주석은 좋은 코드를 대신할 수 없다.
주석은 굳이 쓰지 않는게 좋겠다. 특별한 이유는 없지만 주석을 잘 사용하지 않는 편이여서 다른 장보다 쉽게 읽혔다.
좋은 주석이라는 내용은 새로웠다. 메모해뒀다가 필요할 때 마다 찾아봐야겠다.
<aside> 🔎 궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
</aside>
소감 3줄 요약