[클린코드] 4. 주석 - 요약 및 인사이트

인사이트 정리

주석은 코드가 아니라고 생각해서 대충 입력하고 남겨두는 경우가 많았는데, 

나같은 이런 개발자들이 많이 때문에 더욱이 주석을 사용하면 안된다는 것을 알게 되었다.

주석보다는 코드로 최대한 의미를 전달하도록 하고, 소스코드 관리 시스템로 형상관리를 해보자! 

 

요약

- 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.

- 코드로 의도를 표현할 방법은 없을까? 

- 코드는 변화하고 진화한다. 주석이 언제나 코드를 따라가지는 않는다.

- 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다. 

 

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

- 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

 

2. 코드로 의도를 표현하라!

- 몇 초만 생각하면 코드로 대다수 의도를 표현할 수 있다.

 

3. 좋은 주석 

- 법적인 주석 : 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣어야할 때 

- 정보를 제공하는 주석 : 기본적인 정보를 주석으로 제공하면 편리하다. 하지만 가능하다면 함수 이름에 정보를 담는 편이 더 좋다.

- 의도를 설명하는 주석

- 의미를 명료하게 밝히는 주석 : 모호한 인수나 반환값. 인수나 반환값이 표준 라이브러리나 변경하지 못한 코드에 속한다면 유용하다. 

- 결과를 경고하는 주석 : 요즘에는 @ignore 속성을 이용해 테스트 케이스를 꺼버린다.

- TODO 주석 : 앞으로 할 일을 //TODO 주석으로 남겨두면 편하다. 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애라 권한다. 

- 중요성을 강조하는 주석 : 대수롭지 않다고 여겨질 뭔가의 중요성을 강조 

 

4. 나쁜 주석 (대다수 주석이 이 범주에 속한다.) 

- 주절거리는 주석 

- 같은 이야기를 반복하는 주석 : 코드보다 주석을 읽는 시간이 더 오래걸린다. 

- 오해할 여지가 있는 주석 : 때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게 주석을 달지 못하기도 한다. 

- 의무적으로 다는 주석 

- 이력을 기록하는 주석 : 소스코드 관리 시스템이 있어 이제는 혼란만 가중할 뿐이다. 완전히 제거하는 편이 좋다. 

- 있으나 마나 한 주석 : 너무 당연한 사실을 언급. 개발자가 주석을 무시하는 습관에 빠진다. 

- 함수나 변수로 표현할 수 있다면 주석을 달리 마라 : 주석이 필요하지 않도록 코드를 개선하는 편이 좋겠다. 

- 위치를 표현하는 주석 : 소스 파일에서 특정 위치를 표시하려 주석을 사용한다. 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.

- 닫는 괄호에 다는 주석 : 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화된 함수에는 잡음일 뿐이다. 

- 주석으로 처리한 코드 : 소스코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 그냥 코드를 삭제하라 

- HTML 주석 : 읽기가 어렵다. 

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

- 모호한 관계 : 주석 자체가 다시 설명을 요구하니까 안타깝기 그지 없다. 

- 함수 헤더 : 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.