[CleanCode]주석-이란

들어가기 전에

주석이란 이렇게 코드에 대한 설명을 적어두는 것을 말합니다.

자동 주석 호출
메서드 위에 /** 를 적은 뒤
Enter를 누르면 자동 주석이 적혀집니다.

보통 이런 식으로 작성하구요. return 밑에 최초 작성일, 작성자를 적고 . 수정할 때마다 날짜와 수정내용, 수정자를 적습니다.

---

주석은 필요악이다

• 주석을 유지하고 보수하기는 현실적으로 불가능이라
  주석은 오래될 수록 코드에서 멀어진다.
• 부정확한 주석은 아예 없는 것보다 나쁘다.

---

코드로 의도를 표현하라

안 좋은 예

좋은 예

• 초보자가 보았을 경우에는 고작 저 조건을 검사하려고 메서드를 따로 만들어야 하느냐 생각 할 수 있지만
• 후에 혜택을 받을 조건이 변경될 것을 생각하면 유지보수를 위해 따로 메서드를 만드는 게 좋다.
• 또한 굳이 알 필요 없는 조건을 보기 위해 더 긴 주석을 읽을 필요가 없어진다.
  
  
• 의도를 정확하고 깔끔하게 표현한 코드가, 복잡하고 주석이 많이 달린 코드보다 훨씬 좋다.