Chapter4.md

[Chapter 4] 주석

"우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다."
부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.

주석으로 달려는 설명을 함수로 만들어 표현하라

주석을 꼭 달아야겠다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다. 그리고 근처에 있는 코드만 기술하라.

좋은 주석

1. 법적인 주석 - ex) 저작권 정보, 소유권 정보 등
2. 정보를 제공하는 주석 - 주석으로 정보를 쓰기보단 최대한 함수 및 클래스로 만들도록하자)
3. 의도를 설명해주는 주석
4. 의미를 명료하게 밝히는 주석 - 표준 라이브러리나 변경하지 못하는 코드 한정, 주석이 올바른지 검증하기 쉽지 않으므로 충분한 고민 후 작성해야함
5. 결과를 경고하는 주석 - ex) //여유 시간이 충분하지 않다면 실행하지 마십시오. 등
6. TODO 주석
7. 중요성을 강조하는 주석

나쁜 주석
좋은 주석 제외 모든 주석 (아무튼 주석을 최대한 피하고 함수, 변수 등의 코드 자체로 표현하도록 해라)