TIL (Today I Learned)

2022.01.24

오늘 읽은 범위

4장. 주석

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

• 주석은 나쁜 코드를 보완하지 못한다. 또한 주석은 방치된다. (p.69)

• 나쁜코드에 주석을 달지 말라, 새로 짜라 - 브라이언 W. 커니핸, P.J. 플라우거 (p.68)

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

• 나 또한 함수를 만들고 부연설명을 위해 열심히 주석을 작성하고 주석이 다른 개발자들의 이해를 위해 작성한다고 생각하였다.
  하지만 책에서 처럼 코드로 설명할 수 있으면 주석은 필요없다는 걸 깨닫게 된다.
  즉, 잘 짜여진 함수일 수록 주석은 불필요하고 어쩌면 시간이 지나면 주석은 오히려 이해하기 어렵게 만들겠다라는 생각이 든다.
  결국 마찬가지로 잘 지어진 함수 이름과 변수 이름이 주석을 대신하게 된다.

• 그렇다고 모든 주석이 불필요한 것은 아님을 알려준다.
  당연히 좋은 주석이 있다.
  그중에서 제가 제일 많이 사용되는 것은 @deprecated 이다.
  코드 리팩토링을 할때, 사용할지 안 할지 모르거나 다른 버전에서는 사용 할 수 있기에 해당 어노테이션을 붙여서 중요도가 떨어져 더 이상 사용되지 않음을 표시하고 이후 삭제해야 문제없이 사용할 수 있다.

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

• 쉰들러 리스트

  • 스티븐 스필버그 감독, 주인공 쉰들러가 유대인들을 안전한 곳으로 피신시키기 위해서 작성했다는 아홉 개의 명단이다.