Clean Code 읽기(8)

17장 냄새와 휴리스틱

• “Refactoring”에서 마틴 파울러는 다양한 ‘코드 냄새’를 한다. 거기에 추가한 ‘냄새’들과 코드를 짜면서 사용하는 기교와 휴리스틱을 소개한다.
• 🙋‍♂️ 리팩토링 책은 클린코드를 다 읽은 후 다음에 읽을 책이다.

주석

1. 부적절한 정보
   • 주석은 코드와 설계에 기술적인 설명을 부연하는 수단이다.
   • 예를들어, 변경 이력은 소스 코드를 번잡하게 만들 뿐이다.
2. 쓸모 없는 주석
   • 오래된 주석, 엉뚱한 주석, 잘못된 주석은 쓸모가 없다. 쓸모 없어질 주석은 아예 달지 않는 것이 가장 좋다.
3. 중복된 주석
   • i++ // i증가 or 서명만 기술하는 Javadoc은 중복된 주석이다.
   • 주석은 코드만으로 다하지 못하는 설명을 부언해야한다.
4. 성의 없는 주석
   • 주석을 달 생각이라면 시간을 들여 잘 작성해야한다. 명확한 단어 문장을 사용한다.
5. 주석 처리된 코드
   • 주석 처리된 코드가 있으면 이 코드가 얼마나 오래된 코드인지, 중요한 코드인지 알 방법이 없다. 그래서 혹시 몰라서 지우지 않는다.
   • 그런 코드는 계속 늘어가고 자리만 차지한다. 발견하면 바로 지우는것이 좋다.

🙋‍♂️ 코드워즈 문제를 풀면서 좋은 답들은 주석처리하여 따로 기록해 두는데 코드 파일에 작성하는것보다 별도의 파일을 만들어서 하는것이 더 나으려나?

🙋‍♂️ Javadoc가 뭔지 대충 알고 있긴한데.. api들 보면 장황하게 써져있긴 하더라. 근데 이거 꼭 작성해야하는 주석인지는 잘 모르겠다.