[TIR]cleancode 4.주석

DAY 8~9

🔖 오늘 읽은 범위 :  p.68~

 

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

• 우리는 코드로 의도를 표현못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. p.68
• 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고,중요하니까 지우면 안 된다고 생각한다. p.86
• '앞으로 할 일'을 //TODO 주석으로 남겨두면 편하다. p.74

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

주석에 대한 기본적인 태도는 주석은 되도록 작성하지 않아야 한다는 점이다. 코드는 어떤 기능을 실행하고 있는지 보여주기 때문에 우리는 주석으로 설명을 받기보단 잘 지은 함수이름,변수이름으로 내용을 파악할수 있도록 해야겠다. 나의 경우혼자 작업하는 코드에 주석을 남기곤 했는데 TODO를 위해 남겨둔 주석이 아닌것들은 최대한 제거하는 방향으로 코드를 작성해야 겠다.

 

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

•  

소감 3줄 요약

• 주석은 되도록 작성하지 않는다.
• 주석을 작성해야 한다면 명확하고 꼭 필요한 이유에 의해 작성한다.
• 그러나 주석을 코드를 통해 대체 할수있다면 그렇게 하는 편이 훨씬 좋다.