나쁜 코드에 주석을 달지 마라. 새로 짜라
주석은 나쁜 코드를 보완하지 못한다
- 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 시간에 깨끗이 치우자
코드로 의도를 표현하라
좋은 주석
- 법적인 주석 - 첫머리의 저작권 정보, 소유권 정보
- 정보를 제공하는 주석 - 그래도 가능하면 함수 이름에 정보를 담는편이 좋다
- 의도를 설명하는 주석
- 의미를 명료하게 밝히는 주석 - 그래도 주석이 올바른지 검증하지 쉽지 않다.
주석을 달 때는 더 나은 방법이 없는지 고민하고 정확히 달도록 각별히 주의 - 결과를 경고하는 주석
- TODO 주석 - TODO 주석을 떡칠한 코드는 바람직하지 않다. 주기적으로 없애자
- 중요성을 강조하는 주석
나쁜 주석
- 주절거리는 주석
- 같은 이야기를 중복하는 주석
- 오해할 여지가 있는 주
- 의무적으로 다는 주석
- 이력을 기록하는 주석
- 있으나 마나 한 주석 - 너무나 당연한 사실 언급
- 함수나 변수로 표현할 수 있다면 주석을 달지 마라
- 주석으로 처리한 코드 - 다른 사람들이 지우기를 주저하므로 쓸모 없는 코드가 점차 쌓여간다
- 너무 많은 정보
yesjm's second brain