좋은 주석

개요

좋은 주석, 주석 규칙

• 되도록이면 주석 대신 코드 자체로 설명하려고 노력하자.
• 중복은 피하자. 코드를 반복하는 주석은 필요 없다.
• 코드를 주석처리하지 말자. 그냥 지우자.
• 꼭 필요한 경우에만 사용하자.

의도를 설명할 필요가 있을 경우

경고가 필요한 경우

완성되지 않은 경우

같이 보기

• 주석
• 클린 코드

참고

• https://blog.codinghorror.com/code-tells-you-how-comments-tell-you-why/
• https://gist.github.com/wojteklu/73c6914cc446146b8b533c0988cf8d29#comments-rules