Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
TIL (2022.02.25)
#clean_code
2년 전
451

TIL (2022.02.25)

오늘 읽은 범위

4장. 주석

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

  • 잘 달린 주석은 그 어떤 정보보다 유용하다. (중략) 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. _68p

  • 진실은 한곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 구준히 노력해야 한다. _68p

  • [TODO 주석] 때로는 ‘앞으로 할 일’을 //TODO 주석으로 남겨두면 편하다. _74p

  • [나쁜 주석] 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다. _75p

  • 있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라. 더 낫고, 행복한 프로그래머가 되는 지름길이다. _83p

  • 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라. 잃어버릴 염려는 없다. 약속한다. (중략) 소스 코드에서 HTML 주석은 혐오 그 자체다. _87p

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

  • 이번장은 조금 재밌겠다(?)라고 생각했다가 금방 반성했다. 내가 어딘가에 남긴 코드를 자리에서 조목조목 지적받은 것 같은 기분이 들었다. 어느 라이브러리를 그대로 옮겨다 정리하면서 라이센스나 저자에 관한 주석이 멋져보여 그 ‘주석 남기는 방식'을 그대로 실무에 옮긴 적도 있었는데, 돌이켜보면 코드에 자신 없는 개발자의 허울좋은 장식이었다. 다음 TIL은 리팩토링인데, 사실 자신이 없다.

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

  • 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔...

  • 자기 객체에 높은 순위를 주기 _71p