오늘 TIL 3줄 요약

• 주석 쓰지 마세요. 코드에 양보하세요

• 코드도 유지보수 안하는데 주석은 하겠느냐. 코드가 변할 동안 주석은 코드를 따라가지 못하는 경우가 너무도 많다

• 잡음 없는 주석이라 확신한다면 쓸 수는 있다

TIL (Today I Learned) 날짜

2022.04.28 - 2022. 04. 30

오늘 읽은 범위

4장

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

• 때로는 Javadoc도 잡음이다. Open API가 아니라면 더더욱

• 주석 대신 함수나 변수로 표현을 하라

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

주석을 읽다가 고개를 갸우뚱하고는 코드를 읽는다. 그러고선 ‘이럴거면 그 시간에 코드를 볼 걸’ 시간 낭비한 거 같아 볼멘 소리만 나온다. 이런 경험이 쌓이다보면 아예 주석을 무시하게 된다. 악순환이다. 정말 읽어야하는 주석마저 읽지 않게 되는 것이다.

책에서는 좋은 주석 vs 나쁜 주석을 구분지어 놓았지만 개인적으로는 ‘좋은 주석’ 마저도 불필요하다는 입장이다. TODO나 NOTE 같은 주석은 애자일/스크럼 환경이나 좋은 PR 시스템이 있는 곳에서 굳이? 필요할까 싶다. 결과를 경고하는 주석도 경고까지 필요한 코드가 과연 좋은 코드인가 하는 의문이 든다. 대체 가능한 주석은 피하는 것이 좋겠다.

결국 4장도 이야기의 결은 비슷하다. 코드로 의도를 전달할 수 있다면 주석은 지양하라는 것이다. 클린한 코드, 읽기 쉬운 코드라면 애초에 주석은 불필요하다.

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

• loadProperties