4장 주석

TIL (Today I Learned)

2022.04.29

 

오늘 읽은 범위

4장. 주석

 

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

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

• 때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진 다 // a == a , a! == b (p72)

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

 

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

• 나는 지금까지 주석에 대해 잘못 이해하고 있었던 것이 아닐까 하는 생각이 드는 파트였다. 주석은 단순히 이 코드가 어떤 파트의 코드인지 잘 알아볼 수 있도록 조금더? 편하려고 남기는 싸인(sign) 같은 것이라고 여겼지만, 책 첫장 첫 문장부터 주석을 쓰는 시간에 한눈에 어떤 것을 표현하는지 알수있는 코드를 짜는 것에 더욱 우선순위를 두라는 말에 망치로 머리를 내려쳐맞는듯한 느낌이 들었던 것 같다.
• 주석에 의존하지 말고 조금이라도 한번 더 알아볼 수 있는 코드를 짤 수 있도록 한번 더 리팩토링 하자
• 때로는 함수 이름에 의미를 담는 것도 주석을 남길 필요가 없는 아주 좋은 방법인 것 같다.