클린코드 - 주석

1. 주석은 나쁜코드를 보완하지 못한다 코드에 주석을 추가하는 이유는 코드 품질이 나쁘기 때문이다 따라서 코드만으로 의도를 표현해야한다. 2. 좋은 주석 (예외적 허용 주석) 1. 법적인 주석 2. 정보를 제공하는 주석 3. 의도를 설명하는 주석 4. 의미를 명료하게 밝히는 주석 5. 결과를 경고하는 주석 6. TODO 주석 7. 중요성을 강조하는 주석 3. 나쁜 주석 1. 주절거리는 주석 2. 같은 이야기를 중복하는 주석 3. 오해할 여지가 있는 주석 4. 의무적으로 다는 주석 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다. 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초..........

클린코드 - 주석에 대한 요약내용입니다.

자세한 내용은 아래에 원문링크를 확인해주시기 바랍니다.

원문링크 : 클린코드 - 주석