TIL (Today I Learned)

// 2022.02.24.목

오늘 읽은 범위

// 4장. 주석

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

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

• 있으나 마나 한 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠진다. 코드를 읽으며 자동으로 주석을 건너뛴다. (p82)

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

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

• 교수님께 항상 주석을 많이 다는 습관을 가지라고 배웠어서, 코드를 짤 때 한 문장마다 주석을 달았었다. 91쪽에 있는 바람직하지 못한 주석 찾기의 코드가 내가 짜던 코드의 느낌이었다. 특히 코딩을 하면서 내 의도대로 돌아가지 않는 코드가 있으면 주석 처리를 해두고, 다른 코드를 작성하고는 했는데, 안좋은 습관이라는 것을 알게 되었다. 물론 주석을 달지 않을 방법을 찾아낸 주석이 제일 좋은 주석이라고 하지만, 좋은 주석의 예시로 있는 법적인 주석, 정보를 제공하는 주석, 의도를 설명하는 주석, 의미를 명료하게 밝히는 주석, 결과를 경고하는 주석, , TODO 주석, 중요성을 강조하는 주석 등을 참고하여 앞으로의 내 코드를 발전시키고 싶다.