왜 필요한가
대안, 제약, 실패 조건처럼 코드 밖의 판단이 담겨 있으면 남깁니다.
주석은 유지할 이유가 있을 때 가장 강하다
코드만으로 보이지 않는 의도와 제약을 남기는지 먼저 확인합니다.
현재와 맞는가
구현이 바뀌어 설명이 어긋났다면 주석도 같은 변경에 포함합니다.
반복 설명인가
코드를 그대로 읽어주는 문장은 삭제하거나 의도 설명으로 바꿉니다.
코드만으로 보이지 않는 의도와 제약을 남기는지 먼저 확인합니다.
대안, 제약, 실패 조건처럼 코드 밖의 판단이 담겨 있으면 남깁니다.
구현이 바뀌어 설명이 어긋났다면 주석도 같은 변경에 포함합니다.
코드를 그대로 읽어주는 문장은 삭제하거나 의도 설명으로 바꿉니다.