남겨야 할 주석
성능 우회, 예외 처리, 외부 제약, 임시 선택처럼 코드만으로 배경을 알기 어려운 이유.
좋은 주석은 코드가 말하지 않는 이유를 남긴다
무엇을 하는지는 코드가 말하고, 주석은 왜 그렇게 했는지와 언제 조심해야 하는지를 보완합니다.
줄여야 할 주석
코드가 이미 말하는 동작을 반복하거나, 실제 코드와 쉽게 어긋날 수 있는 설명.
왜?왜 이 선택을 했는지 남겼는가?
언제?어떤 조건에서 조심해야 하는가?
유지?코드가 바뀔 때 같이 바꿀 수 있는가?