[클린코드] 8일차. 67-74pg | 주석, 좋은 주석

8일차.

클린코드[2주차_화요일]
67-74pg



#요약

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

- 주석은 실패를 의미한다. 내가 코드로 풀어내지 못했다는 뜻
- 코드로 의도를 풀어내야 한다.
- 주석은 오래될수록 코드에서 멀어진다.
- 부정확한 주석은 아예 없는 주석보다 훨씬 나쁘다.

1) 주석은 나쁜 코드를 보완하지 못한다.
- 코드 품질이 나쁘니까 주석을 추가한다.

2) 코드로 의도를 표현하라!
- 주석으로 달려는 설명을 함수로 표현할 수도 있다.

3) 좋은 주석
- 주석을 달지 않을 방법을 찾아낸 주석이 좋은 주석이다.
// 법적인 주석 : 저작권정보와 소유자 정보
// 정보를 제공하는 주석 : 가능하면 함수이름에 정보를 담자
// 의도를 설명하는 주석 : 결정에 깔린 의도까지 설명하는 주석
// 의미를 명료하게 밝히는 주석 : 대신 엄청 정확히!
// 결과를 경고하는 주석
// TODO 주석 : 필요하다 여기지만 당장 구현하기 어려운 업무 기술 -주기적 점검으로 필요없으면 삭제