Clean Comment

"Clean Comment의 원칙"

- Comment는 필요악

- Comment보다 Code 그 자체가 의미가 있어야 함

 

"Bad Comment"

- Code 자체를 개선해야 함. 코멘트로 이해 시키려고 하면 안됨.

- 중복된 정보를 제공 하는 커멘트

- git 형상 관리로 안쓰는 code는 관리 해야 함.

- 수정 이력을 남겨놓는 것들 또한 git에서 관리 하도록 해야 함

- Comment 자체가 bad smell임

 

"Clean Comment"

- 저작권 명시

- 불가피하게 이름만으로 충분히 의미를 전달하기 어려운 경우

- TODO comment

 

"Summary"