Clean Code: 주석

주석은 근본적으로 악(惡)이다. 주석을 달기보다는 코드가 자신의 의도를 더 잘 설명할 수 있도록 코드를 수정하는 것이 낫다.

1. 좋은 주석

• 법적인 주석
  저작권, 소유권 정보 등

• 정보를 제공하는 주석
  다만 코드상에서 정보를 제공할 수 있다면 주석을 없애는 것이 좋다.

• 의도를 설명하는 주석

• 의미를 명료하게 밝히는 주석
  보통은 코드 자체에서 의미를 명료하게 하도록 하는 것이 좋지만, 변경할 수 없는 코드라면 주석이 필요하다.

• 결과를 경고하는 주석

• TODO 주석
  앞으로 해야 할 일이 있다면 남겨두되, 주기적으로 점검하여 없애도 괜찮은 주석은 지우는 것이 좋다.

• 중요성을 강조하는 주석

2. 나쁜 주석

위의 좋은 주석을 제외한 나머지 주석은 모두 나쁜 주석이다.
어떻게 하면 주석을 달지 않을 수 있을까 고민하는 것이 좋다.