11-1.불필요한 주석 Comments
주석은 최소한으로 남기는 게 좋습니다.
- 코드를 이해하는데 오히려 방해가 된다.(잘못된 주석과 코드중 무엇이 맞는지 판단하기 어렵다.) - 코드를믿자.
- 만약 어떤 주석을 코드로 바꿀 수 있거나 생략해도 별 문제가 없다면, 그 주석은 불필요한 주석이다.
// 객체를 생성한다.
create_object();
필요한 주석
- 그건 왜 코드가 필요한지 설명해야 할 때.
- 코드에 어떤 개선이 필요함을 적어야 할 때.
- 꼭 필요하지는 않지만 주석이 있으면 때에 따라 좋을때( 코드 여러줄의 의미를 추상적으로 짧게 설명할 때)
- 상위 수준의 코드를 이해하기 힘들때 -> 해당 블록을 함수로 떼 내는게 좋지만 이것 또한 어려울 때 주석을 단다.