TIL (Today I Learned)

2022.02.25

오늘 읽은 범위

4장. 주석

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

• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라! (p. 69)

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

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

• 코드의 첫 작성때는 유의미했던 주석들이 코드가 변경되고 수정되면서 오히려 혼란을 주는 경우를 종종 보았다. 코드의 수정과 더불어 주석도 체크해야겠고, 더 나아가선 주석이 굳이 필요없는 네이밍과 로직으로 코드를 작성해야한다.

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