[클린코드] 주석

주석

 

주석은 나쁜 코드를 보완하지 못한다.

코드로 의도를 표현하라!

좋은 주석

-       법적인 주석

-       정보를 제공하는 주석

-       의도를 설명하는 주석

-       의미를 명료하게 밝히는 주석

-       결과를 경고하는 주석

-       중요성을 강조하는 주석

나쁜주석

-       주절거리는 주석

-       같은 이야기를 반복하는 주석

-       오해할 여지가 있는 주석

-       의무적으로 다는 주석(javadoc의 모든 변수에 다는 주석)

-       이력을 기록하는 주석

-       있으나 마나 한 주석

-       …