////
Search
Duplicate
🪅

주석

C1: 부적절한 정보

소스 코드 관리 시스템, 버그 추적 시스템, 이슈 추적 시스템에 저장할 정보들은 주석으로 적합하지 못하다.

C2: 쓸모 없는 주석

오래된 주석, 엉뚱한 주석, 잘못된 주석은 필요 없다. 쓸모가 없어질 가능성이 있는 주석은 달지 않는 것이 최선이다.
쓰레기로 남아 불필요한 오해만 불러일으킬 뿐이다.

C3: 중복된 주석

코드만으로 충분한데 구구절절 설명하는 주석이다.
좋은 주석은 코드로 설명불가능한 것을 설명하는 주석이다.

C4: 성의 없는 주석

당연한 소리를 반복하지 말자. 간결하고 명료하게 전달해야하는 것만 단순하게 전달하는 주석이 좋다.

C5: 주석 처리된 코드

주석으로 처리된 코드가 우리는 쓰일 코드인지, 쓰였던 코드인지, 중요한 코드인지 알 턱이 없다.
그냥 없애라 최악이다.