TIL (Today I Learned) 날짜

2022.04.28

오늘 읽은 범위

4장. 주석

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

• 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다. (p.69)

• 때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다. (p.73)

• 때로는 '앞으로 할 일'을 //TODO 주석으로 남겨두면 편하다. (p.74)

  • 함수나 변수로 표현할 수 있다면 주석을 달지 마라 (p.84)

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

• 주석은 최대한 함수나 변수로 포함하되 코드를 사용한 이유를 다른 프로그래머에게 전달할 필요가 있을 경우가 달자.

• 주석이 위험한 이유는 코드는 진화하지만 그에 맞춰 주석을 바꾸는 수고를 안하기 때문에 괴리가 생길 수 있다.

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

• Javadocs