Community

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

← Go back
TIL 4장 주석
#clean_code
2년 전
374


TIL (Today I Learned)

  • 2022-02-24

오늘 읽은 범위

  • 4장 주석

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

- (p.69) 진실은 한곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다.
코드만이 정확한 정보를 제공하는 유일한 출처다.
- (p.69) 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
- (p.75) 나쁜 주석, 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나,
미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
- (p.84) 함수나 변수로 표현할 수 있다면 주석을 달지 마라
- (p.86) 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까
지우면 안 된다고 생각한다. 그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다.
- (p.87) 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다.
그냥 코드를 삭제하라, 잃어버릴 염려는 없다. 약속한다.

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

- Todo 주석을 남발하는 습관을 고쳐야겠다.
- Todo 주석을 최대한 빠르게 처리하자.
- 쓸모있겠지라고 생각하고 주석으로 남겨둔 코드를 모두 삭제하고, 필요 시 git 이력으로 확인하는 습관을 길러야겠다. 

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