클린코드 Day 7-8. 주석 쓰는 방법

✅ 이 포스팅은 노마드 코더 북클럽  '클린 코드' 챌린지를 진행하면서 작성하는 TIL이며,  출처는 Clean Code입니다.

 

📚 범위 :  04. 주석

 

 

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

• 주석 필요도 ⬇ 수록 좋은 코드
• 하나의 코드를 설명하기 위해 주렁주렁 comment를 작성하기보다는
  코드만 봐도 어떤 의미인지, 어떤 역할을 하는지 알 수 있도록 작성한 코드가 좋은 코드이다.
• 주석이 필요한 경우
  • 다른 사람에게 요구사항을 전달하는 경우에 해당
    But! 주기적으로 확인하고 지우는 것이 좋다. 다른 사람이 필요한 주석이라고 오해할 수 있음
• 주석이 필요하지 않은 경우
  • function, variable로 표현 가능한 경우
  • 주석이 필요하다고 생각되지만 코드를 개선하는 것이 가능한 모든 경우
  • 애초에 주석이 필요한 상황을 만들지 말자!

 

 

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

저자는 나쁜 코드에 대한 감정이 매우 좋지 않은 듯 하다. 한 장 한 장 읽을 때마다 좋지 않은 코드에 대한 분노가 느껴진다. ㅋㅋㅋㅋ  첫 장이 특히 뼈를 너무 많이 때리는 듯했다. 마치 주석을 달 때마다 코드 표현력이 없다는 사실을 인정해야만 하는 것 같았다.

하지만 계속 읽다보니 결국 이 책에서 가장 중요한 내용은 첫 장이라는 생각이 들었다. 처음부터 깨끗한 코드를 짜려고 노력하고, 다른 사람이 읽어도 이해가 잘 될 수 있도록 코드를 짜도록 노력해야 한다는 정보가 담겨있으니까 말이다.

이 장에서 말하는 내용은 다른 사람이 이해할 수 있도록 들여야 하는 노력에 주석은 포함되어 있지 않다는 점이다. 알맞은 코드, 함수, 변수로 바로 이해되게 만들어야지 주석이 필요하다면 제대로 만들어진 코드가 아니라고 강조한다. 아무래도 지난 코드들을 돌아보면서 쓸데없는 주석을 지우고 좋은 코드가 될 수 있도록 수정하는 시간을 가져야 할 것 같다.

 

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

아무래도 JAVA 코드 기준이라서 그런가 프론트쪽 하고는 조금 다르다고 생각한다. 특히 CSS 같은 경우는 어디에 해당되는 코드인지 주석으로 구분을 해주어야 할 것 같은데... 아니면 애초에 그렇게 하지 않아도 되도록 클래스와 아이디 이름에 구역까지 잘 포함해서 이름을 지어야 하나보다.

그리고 내가 자꾸 주석을 쓰게되는 이유 중 하나는 아무래도 코드가 영어로 되어있어서 인 것 같다. 단어 뜻이나 함수명이 한글처럼 바로 와닿지 않아서 자꾸 주석을 다는 것 같다. 영어공부를 더 열심히 해야겠다는 생각이 또 든다!