20220224_북이

🪴ㅤTIL (DAY - 5)

2022.02.24

오늘 읽은 범위

👉ㅤ클린코드 4장. 주석

기억하고 싶은 내용ㅤ📕

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.(p.69)

"이런! 주석을 달아야겠다!" 아니다! 코드를 정리해야 한다! (p.69)

있으나 마나 한 주석으로 분풀이를 하는 대신
프로그래머가 코드 구조를 개선했더라면 짜증낼 필요가 없었을 터이다.(p.83)

소스 코드에서 HTML 주석은 혐오 그 자체다.(p.87)

오늘 읽은 소감ㅤ📙

오늘은 주석에 대해 조금 더 정리를 하고자 한다.

여지껏 닫는 괄호 뒤에 주석을 다는 습관을 가졌었는데, 이것이 좋지 못하는 주석임을 이제야 인지하게 되었다.
주석을 다는 것은 매우 중요하지만 자칫하면 코드를 더 부정확하게 만들 수 있다는 것 !
뭐든 과하면 좋지 않다는 옛말은 정말로 정확한 것이었다.....!

궁금하거나 이해가 잘 가지 않는 내용ㅤ📘

🦖ㅤJavadoc ?
👉ㅤJavaDoc은 JDK와 함께 패키지로 제공되는 특수 도구입니다.
HTML 형식으로 Java 소스 코드의 코드 문서를 생성하는 데 사용됩니다.

#노마드코더 #북클럽 #노개북