오늘 TIL 3줄 요약

• 주석보다는 코드로 의도를 표현해야 한다.

• 주석을 달아야 할 때는 코드로 어떠한 방법이든 표현할 방법이 없을 때 쓰면 유용하다.

• 주석을 달기 전에 주석을 달아야 할 이유에 대해 다시 한번 생각하고 써야 한다.

TIL (Today I Learned) 날짜

2022.04.28

오늘 읽은 범위

4장. 주석

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

• 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.

• 주석은 오래될수록 코드에 서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다

• 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하 게 밝히는 주석이 유용하다.

• @Ignore(“실행이 너무 오 래 걸린다.”)라고 쓴다. 하지만 JUnit4가 나오기 전에는 메서드 이름 앞에 _ 기호 를 붙이는 방법이 일반적인 관례였다.

• 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓 았으리라고, 중요하니까 지우면 안 된다고 생각한다. 그래서 질 나쁜 와인병 바 닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다.

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

• 함수를 만들고나서 다른사람이 봤을때 좀더 빨리 이해를 하면 좋을 것 같아 무슨 기능을 하는 주석인지 달아놓은 적이 종종 있었는데 그것 또한 불필요한 주석이 될 수 있다라는 것에 대해 생각해보게 됐다.

• 책에서 말하는 나쁜 주석의 예시가 굉장히 많았다. 대부분의 주석은 필요가 없고 코드로 의도를 표현하는 것이 실패해서 적는거라고 한다. 주석을 달기 전에 코드가 먼저 잘 표현되어 있는지 확인해봐야 겠다.

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