[Clean Code] 4장, 주석

Clean Code - 로버트 C. 마틴

4장, 주석

 

주석은 코드로 의도를 표현하지 못해서, 실패를 만회하기 위해서 사용함

🔴 주석은 필요 악 🔴
- 주석을 유지/보수하기 어려움
- 주석이 코드를 항상 따라가지 않음
- 주석이 부정확한 고아가 되는 사례가 많음
- 부정확한 주석은 없는 주석보다 훨씬 나쁨

 

1. 주석은 나쁜 코드를 보완하지 못함

 

- 주석을 추가하는 이유: 코드 품질이 나쁘기 때문

 

 

2. 코드로 의도를 표현

- 주석을 사용하지 않고 코드로 표현

 

 

3. 좋은 주석

 

1) 법적인 주석 ex. 저작권 정보

 

2) 정보를 제공하는 주석 ex. 정규표현식의 시간과 날짜

 

3) 의도를 설명하는 주석

 

4) 의미를 명료하게 밝히는 주석 ex. 모호한 인수나 반환 값

if(a.compareTo(a) == 0){} // a == a

if(a.compatreTo(ab) == 0) // ab == ab

 

5) 결과를 경고하는 주석

 

6) TODO 주석

 

7) 중요성을 강조하는 주석

 

8) 공개 API의 Javadocs

 

 

4. 나쁜 주석

 

1) 주절거리는 주석

try{
	...
}
catch(Exception e){
	// 속성 파일이 없다면 기본값을 모두 메모리로 읽어들였다는 의미다.
}

- catch의 주석을 해석하기 위해 다른 코드를 봐야함

 

2) 같은 이야기를 중복하는 주석

// closed가 false면 에러를 던진다.
if(!closed)
    throw new Exception("에러");

 

3) 오해할 여지가 있는 주석

 

4) 의무적으로 다는 주석

/**
*
* @param title CD 제목
* @param author CD 저자
* @param tracks CD 트랙 숫자
*/

 

5) 이력 기록

- 혼란 가중

 

6) 새로운 정보를 제공하지 못하는 주석 (= 중복)

 

7) 무서운 잡음

- 복붙 오류(잘못된 정보)

 

8) 함수나 변수로 표현할 수 있을 경우 주석❌

 

9) 위치를 표시하는 주석

// Action /////////////////

- 잡음

- 드물게 사용

 

10) 닫는 괄호에 다는 주석

- 함수를 줄여서 해결

 

11) 공로를 돌리거나 저자를 표시하는 주석

 

12) 주석으로 처리한 코드

- 쓸모 없는 코드가 점차 쌓여감

 

13) HTML 주석

- HTML은 IDE에서 읽기 힘듦

 

14) 전역 정보

- 주석을 달 때, 주석 근처에 있는 코드만 사용

- 전반적인 내용을 기술X

 

15) 너무 많은 정보

 

16) 모호한 관계

- 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야함

- 주석 자체가 다시 설명을 요구하면 안됨

 

17) 함수 헤더

- 짧은 함수에는 긴 설명이 필요 없음

 

18) 비공개코드에서 javadocs 주석은 필요하지 않음

 

19) 예제

- 중복

 

 

결론: 주석은 중복 없이, 필요한 것만, 간단하게