책너두 5기 10일차
로버트 C. 마틴의 클린코드 p.84 ~ p.94
내용 정리
함수나 변수로 표현할 수 있다면 주석을 달지 마라
명명법을 올바르게 사용하여 주석의 필요성을 없애자.
위치를 표시하는 주석
// Actions //////////// 같은 배너 아래에 모아두는 것은 필요할 때도 있지만 극히 드물게 사용해야 한다.
닫는 괄호에 다는 주석
차라리 함수를 줄이는데 시간을 쓰자
저자를 표시하는 주석
준수가 작성함은 소스 코드 관리 시스템이 있는 한 무의미한 주석이다.
주석으로 처리한 코드
내가 주석으로 처리하면, 다른 사람은 지우기를 주저 한다. 이전의 기록은 소스 코드 관리 시스템이 한다. 지금 필요없으면 지우자. 기록은 존재한다.
HTML 주석
읽기조차 어렵다.
전역정보
주석은 근처에 있는 코드에 대해서만 말해야 한다.
너무 많은 정보
최대한 필요한 핵심만 간략히.
모호한 관계
주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
함수 헤더
짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
비공개코드에서 Javadocs
공개하지 않을 코드라면 Javadocs는 의미가 없다.
읽고 나서
내가 생각하는 것 이상으로 주석은 쓸데 없는 경우가 훨씬 많았다. 적어도 지금 내 수준에선 반드시 주석으로 설명해야 할 수준의 코드는 없다. 장황한 주석으로 나의 의도를 어떻게 설명할지 고민할 시간에 코드를 검토하는게 좋겠다.
