Programming/ETC

<클린 코드> 4강. 주석

리버김 2023. 1. 3.
일 하면서 코드를 짜다가 올바르게 주석을 다는 법에 대해 문득 궁금해졌다. 싸피에서 프로젝트를 하면서 시간 없다는 핑계로 주석을 달지 못할 때도 있었지만, 코드를 다시 보면서 공부하는 편인 나 스스로를 위해서라도 주석을 충분히 다는 편이었다. breadcrumbs를 수정하면서 코드를 대폭 수정하면서도 주석을 거의 코드 단위로 달고 있었는데, 회색 주석이 빽빽하게 있는 화면을 보면서 주석이 많은 게 꼭 좋지는 않을 것 같다는 생각을 했다. 하지만 내 뇌피셜만 믿고 넘어갈 수 없었기에 '주석 잘 다는 법'을 구글링해보니 그 유명한 클린코드에 한 장을 할애해서 적혀 있었다. 아직 클린코드를 읽어 보지 못헀지만 잘 정리한 글이 있어서 북마크!
 

[클린코드] 4강. 주석

4장. 주석 주석이 나쁜 이유 나쁜 코드에 주석을 달지 마라. 새로 짜라. 브라이언 W. 커니헨, P.J. 플라우거 잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하

hirlawldo.tistory.com

 

댓글