책너두 5기 9일차
로버트 C. 마틴의 클린코드 p.74 ~ p.83
내용정리
나쁜 주석
대부분은 나쁜 주석이다.
주절거리는 주석
특별한 목적이나 이유가 없는 주석. 달아야 한다면 제대로 명확하게 달자
같은 이야기를 중복하는 주석
코드 내용을 그대로 중복하는, 쓸데없는 주석
오해할 여지가 있는 주석
값이 반환되는 곳, 조건 등이 불확실하게 전달되선 안된다.
의무적으로 다는 주석
모든 코드에 주석을 달아야 한다는 등의 규칙은 불필요하다.
이력을 기록하는 주석
이젠 깃과 같은 관리 시스템이 존재하니 필요 없어졌다.
있으나 마나 한 주석
새로운 정보를 제공하지 못하거나 너무 당연한 사실은 필요 없다.
무서운 잡음
The name, The version 등등..
읽고 나서
기존에 하던 프로젝트에서는 주석으로 어떤 함수나 구문에 대해 깔끔하게 설명해놓는 습관이 있었다. 읽는 사람을 배려하는 차원이기도 했고, 혹여나 내 코드를 못알아 볼까 하는 노파심이었다. 책에서 나온대로, 그 시간에 코드를 깔끔하게 정리하는게 훨씬 낫겠다.
