[Nomad Coder] 노개북 클린코드 챌린지 2기 Assignment 6

 

TIL (Today I Learned)

2022.02.22 - 2022.02.24

 

오늘 읽은 범위

4장. 주석

 

 

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

• 나쁜 코드에 주석을 달지 마라. 새로 짜라.
• 사실상 주석은 기껏해야 필요악이다.

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

• 코딩을 막 처음 시작했을 때, 코드가 잘 이해가 가지 않아서 한국어로 한 줄 한 줄 주석을 달며 이해하려고 애썼던 시절이 문득 생각났다. 마치 영어를 잘 모를 때 지문을 한 줄 한 줄 독해하듯이.. 그 뒤로는 그런 짓은 안하지만 한동안은 코드를 짜기 전에 수도 코딩 할 때 주석을 달고 한국어로 코드를 짰다. 그리고 그 한국어로 된 수도코드를 실제 코드로 번역하여 작성하고, 의도한대로 동작하는 것을 확인한 후, 주석을 제거하는 식이다. 이제는 TDD(테스트 주도 개발)을 하게 되면서 테스트가 수도코드의 역할을 대신 해주는 것 같다. 점점 코드로 읽고 쓰는 것이 익숙해지고 있는 것을 느낀다. 점점 네이티브가 되는 것 같다.
• 애초에 코드를 잘 짰으면 주석이 필요가 없다는 말 공감된다. 기록을 남기면 그걸 매번 동기화하는 등의 관리가 들어가야 하는데, 관심사가 분산되면 그게 힘들어지기 십상이다. 코드를 예쁘게 짜서 술술 익혀서, 주석이 필요 없도록 만들어야 한다.

 

 

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

• 주석도 마찬가지로 간단하고 명료하게, 꼭 필요한 정보를 전달해야 한다.