[클린코드] 10일차. 84-94pg | 나쁜 주석

 

 

10일차.

클린코드[2주차_목요일]
84-94pg



#요약

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

1) 주석은 나쁜 코드를 보완하지 못한다.
2) 코드로 의도를 표현하라!
3) 좋은 주석

4) 나쁜 주석

// 함수나 변수로 표현할 수 있다면 주석을 달지 마라

// 위치를 표시하는 주석 : 특히 뒷부분에 / 로 이어지는 잡음은 제거하는 편이 좋다. 배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다.

// 닫는 괄호에 다는 주석 : 닫는 괄호에 주석을 달기 보다는 함수를 줄이려 노력하라

// 공로를 돌리거나 저자를 표시하는 주석 : 이런 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.

// 주석으로 처리한 코드 : 삭제해도 된다. 잃어버릴 염려 없다. 약속한다. ㅋㅋ

// HTML 주석 : 소스코드에서 HTML 주석은 혐오 그 자체

// 전역정보 : 주석을 달아야 한다면 근처에 있는 코드만 기술하라

// 너무 많은 정보

// 모호한 관계 : 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.

// 함수 헤더

// 비공개 코드에서 Javadocs : 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.

// 예제 주석은 고민해볼 필요가 있다.