[IT/책] Clean Code(클린 코드) - 주석

저는 코드를 짤 때 보통 주석을 쓰지 않습니다. (todo처럼 임시로 달아놓는 주석 제외)

이것도 신입 때 받은 교육의 일환인데 주석 없이도 잘 읽히는 코드를 짜란 말을 많이 들어 왔죠.

책에서 다루는 내용도 일맥상통하더군요.

아무래도 그 때의 상사분도 이 책을 읽으신듯.

 

Clean Code (로버트 C.마틴 지음) 의 4장 내용을 다루고 있습니다.

 

주석을 써도 좋은 상황

- 코드의 저작권 정보

- 정보를 제공하는 주석 (ex: 정규표현식이 어떤 형식을 나타내는지)

- 의도가 명확하게 드러나지 않는 코드에 의도를 설명하는 주석

- 의미를 명료하게 밝히는 주석 (ex: a.compareTo(b) != 0    // a != b) -> 가독성이 좋아짐.

- 다른 사람과 작업 시, 경고하는 주석 (ex: 실행하지 마시오)

- todo 주석

- 중요성이 드러나지 않는 코드의 중요성을 강조하는 주석

 

 

 

사실 안 쓰는 게 제일 좋다고 합니다.