TIL (Today I Learned)

2022.02.25

오늘 읽은 범위

4장. 주석

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

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

• 주석은 '순수하게 선하지 못하다. 사실상 주석은 기껏해야 필요악이다. (p.68)

• 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까.(p.68)

• 진실은 한곳에만 존재한다. 바로 코드다. (p.69)

• 실제로 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다. 엔진 후드를 열어볼 필요가 없다며 고객에게 아양 떠는 중고차 판매원과 비슷하다. (p.77)

• 코드가 바뀌면서 주석은 거짓말로 바뀐다. (p.82)

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

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

주석은 필요하지만 필요하지 않다는걸 느꼈습니다. 그동안 주석을 어떤 생각으로 달았을까 되돌아보면 정말 애매해서 설명할 수 밖에 없는 코드에 달았던 것 같았다. 물론 필요한 주석 일수도 있지만 코드를 좀 더 명확하게 잘 썼으면 싶었지 않았을까 한다.

중고차 판매원 예시를 보고 얼마나 웃었는지. 예시가 너무 적절해서 웃음만 나왔다.

정말로 지속가능한 코드를 위해선 필수 주석은 필요하겠지만, 코드에만 집중에서 코드로 설명할 수 있는 그런 프로그래머가 되어야 겠다고 생각이 들었다.