Clean Code - 4장 주석

Clean Code를 읽고 정리한 글입니다. 
240313. 23:51

 

부정확한 주석은 없는 것보다 나쁘며, 주석을 가능한 줄이도록 끊임없이 노력해야 한다. 

 

주석은 나쁜 코드를 보완하지 못함

코드로 의도를 표현하기

 

좋은 주석

법적인 주석

저작권 정보/ 소유권 정보는 필요한 주석이다. 

 

정보를 제공하는 주석

// kk:mm:ss EEE, MMM dd, yyyy 형식
Pattern timeMatcher = Pattern.compile(
"\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*");

 

의도를 설명하는 주석

의미를 명료하게 밝히는 주석

결과를 경고하는 주석

TODO 주석

중요성을 강조하는 주석

공개 API에서 JavaDocs

나쁜 주석

주절거리는 주석 

같은 이야기를 중복하는 주석

오해할 여지가 있는 주석

의무적으로 다는 주석

이력을 기록하는 주석

함수나 변수로 표현할 수 있는 로직을 주석으로 표현하는 경우

닫는 괄호에 다는 주석

위치를 표시하는 주석 (ex. // Actions //////////////////////////////// )

공로를 돌리거나 저자를 표시하는 주석

주석으로 처리한 코드 : 중요하니까 지우면 안되는 코드라고 생각할 수 있음

HTML 주석

전역 정보 : 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기입하지 말 것.

너무 많은 정보 : 코드와 관련 없는 정보를 장황하게 늘어놓지 말 것. 

모호환 관계 : 주석과 주석이 설명하는 코드와의 관계가 명백해야 함.