- 주석은 거짓말을 할 수 있다.
- 잘 적어놨던 내용이더라도 코드가 수정됨에 따라 주석도 같이 수정해야하는데 빼먹는 경우가 종종 있다.
- 그러면 주석은 잘못된 정보를 전달하게 된다.
- 잘못된 정보가 주석에 있어서 혼란을 줬던 예시 https://github.com/algo-care/algocare-device-app/pull/1085#discussion_r1159229141
- 코드로 충분히 표현할 수 있는 내용을 주석으로 불필요하게 남기는 예시
코드로 표현할 수 있는 부분은 주석으로 남기지 않는다.
Tags