[TIL] 클린코드- Day8_2022.01.28

Day8

📔 오늘 읽은 범위 : 4.주석

💜 책에서 기억하고 싶은 내용

• 주석은 순수하게 선하지 못하다.
• 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
• 때로는 기본적인 정보를 주석으로 제공하면 편리하다.

💙 읽은 소감

개발을 하면서 처음에는 내 코드를 잊으면 안된다고 언젠가는 필요하다고 생각하여 주석 처리를 한 다음에 다른 코드를 작성하였었다. 하지만, 내가 주석처리한 부분을 훗날 다른 사람이 보았을 때 어떤식으로 처리를 해야할 지 모르는 상황이 발생하게 되면 그 주석들은 어떻게 하지도 못하는 레거시로 남게 되는 것 같다.
정말 주석을 추가하는 것은 코드만으로도 내용을 알 수 없어서, 코드 품질이 나빠서 인 것 같다. 내가 정말 좋은 깨끗한 코드를 쓴다면 이러한 일은 발생하지 않을 것이라는 것. 하지만 주석이 꼭 나쁜 것만은 아니라, 적제적소에 사용하면 오히려 좋을 수도 있다.

🤍 잘 이해되지 않는 내용 & 알게 된 것들

좋은 주석을 다는 방법들을 다시 한 번 정리해 봐야겠다!