[Clean Code]4장 주석

책에 있는 내용 중 기억할 만한 내용 정리한 것.

 

우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.

 

우리가 코드로 의도를 표현할 때 마다 스스로를 칭찬해주자,,

반대로 주석을 달 때마다 자신에게 표현력이 없다는 사실에 푸념해야 마땅하다고 한다..

 

부정확한 주석은 아예 없는 주석보다 훨씬 나쁘다.

 

주석은 나쁜 코드를 보완하지 못한다.. -> 주석으로 달려는 설명을 함수로 만들어 표현해라

 

좋은 주석도 있다. (필요하거나 유익하다)

1. 법적이 주석
2. 정보를 제공하는 주석
3. 의도를 설명하는 주석
4. 의미를 명료하게 밝히는 주석,,(신중히 달아야 해!!)
5. 결과 경고하는 주석
6. TODO 주석 (앞으로 할일을 남겨두는 주석)
7. 중요성을 강조하는 주석

 

나쁜 주석 (대부분의 주석이 여기에 속한다.)

1. 주절거리는 주석
2. 코드 내용을 그대로 중복하는 주석
3. 오해할 여지가 있는 주석
4. 이력을 기록하는 주석 -> 소스 코드 관리 시스템을 사용하자
5. 위치를 표현하는 주석
6. 닫는 괄호에 다는 주석
7. Html 주석
8. 전역정보