4. 주석

경력이 정말 짧은 저 임에도 학창시절에 교수님이 예시로 짜준 코드들에서도 많이 보던 실수들 이었습니다.

 

딱 이 챕터를 다 읽고 드는 생각은 한문장으로

 

"설명이 필요한 드립은 실패한 드립이다."  였습니다.

 

주석도 똑같다는 맥락입니다.

 

설명이 필요한 코드는 실패.. 까지는 아니지만 설명이 필요 없는 코드일수록 좋다는 이야기가 계속 나옵니다.

 

꼭 필요한 주석만 남기고 다 없애는게 좋다고 주장합니다.

 

 

1. 법적인 주석

ex) Copyright (C) 2003,2004,2005 by Object Mentor, Inc. All rights reserved.

 

 

2. 정보를 제공하는 주석

ex) 테스트중인 Responder 인스턴스를 반환한다.

 

다만 정보를 제공하는 주석의 경우에는 함수 이름등으로 정보를 직접 담는게 낫다고 합니다.

 

 

3. 의도를 설명하는 주석, 의미를 명료하게 밝히는 주석

표준라이브러리 등이라서 함수나 인수이름을 변경하기 어려운 경우,

아무리 머리를 쥐어짜도 명확한 이름을 만들 수 없는 경우에는 의미를 밝히기 위해서 주석이 있으면 좋음

 

 

4. 결과를 경고하는 주석

ex) SimpleDateFormat은 스레드에 안전하지 못하다.

 

 

5. TODO 주석

앞으로 뭘 해야할지 표시

다만 남발하지 말 것...

요즘은 ide에서 TODO만 찾아서 검색해주는 서비스도 굉장히 잘 돼 있다.

 

 

 

 

될 수 있으면 주석이 필요없는 쪽으로 노력하고, TODO와 법적 주석만 활용하는 방식으로 하는게 좋을 것 같습니다.