[클린코드] 9일차. 75-83pg | 좋은 주석, 나쁜 주석

 

9일차.

클린코드[2주차_수요일]
75-83pg



#요약

1. 깨끗한 코드
2. 의미 있는 이름
3. 함수
4. 주석

1) 주석은 나쁜 코드를 보완하지 못한다.
2) 코드로 의도를 표현하라!
3) 좋은 주석
// TODO 주석 : 필요하다 여기지만 당장 구현하기 어려운 업무 기술 -주기적 점검으로 필요없으면 삭제

// 중요성을 강조하는 주석

// 공개 API에서 Javadocs: 설명이 잘 된 공개 api는 유용하다.

 

4) 나쁜 주석

- 대다수의 주석이 나쁜 주석이다.

 

// 주절거리는 주석 : 주석을 달기로 했다면, 충분한 시간을 들여 최고의 주석을 달도록 해야 한다.

// 같은 이야기를 중복하는 주석 : 주석이 코드보다 더 많은 정보를 제공하지 못한다.

// 오해할 여지가 있는 주석

// 의무적으로 다는 주석

// 이력을 기록하는 주석 : 때때로 모듈 편집할 때마다 주석을 추가하는 것

// 있으나 마나 한 주석 : 너무 당연한 사실을 언급하면서 새로운 정보를 주지 못함

// 무서운 잡음 : 때로는 Javadocs도 잡음이다.