Clean Code - 04. 주석
나쁜 코드에 주석을 달지 마라. 새로 짜라.
주석은 코드로 의도를 표현하지 못해 사용하게 된다.
주석은 오래될수록 코드에서 멀어진다.
-> 오래될수록 코드는 변화하고 진화하고, 원래의 의미와 달라질 가능성이 높아진다.
부정확한 주석은 아예 없는 주석보다 훨신 나쁘다.
주석은 나쁜 코드를 보완하지 못한다
표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드 »> 복잡하고 어수선하며 주석이 많이 달린 코드
코드로 의도를 표현하라!
몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
좋은 주석
법적인 주석
회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시하는 경우
정보를 제공하는 주석
기본적인 정보를 주석으로 제공하면 편리하다.
의도를 설명하는 주석
구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
의미를 명료하게 밝히는 주석
때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
결과를 경고하는 주석
다른 프로그래머에게 결과를 경고할 목적으로 사용
TODO 주석
‘앞으로 할 일’을 //TODO 주석으로 남겨두면 편하다.
프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
중요성을 강조하는 주석
공개 API에서 Javadocs
설명이 잘 된 공개 API는 유용하고 만족스럽다.
나쁜 주석
일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
주절거리는 주석
주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.
같은 이야기를 중복하는 주석
오해할 여지가 있는 주석
의무적으로 다는 주석
모든 함우세 Javadocs를 달거나 모든 변수에 주석을 달게 되면 코드를 복잡하게 만들고, 혼동과 무질서를 초래할 수 있다.
이력을 기록하는 주석
소스 코드 관리 시스템이 있기 때문에 모듈 첫머리에 이력을 기록할 필요가 없다.
있으나 마나 한 주석
너무나 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석
지나친 정보를 주면 개발자가 주석을 무시하는 습관이 생기고, 나중에는 주석을 건너뛰는 경우가 발생해 주석과 코드가 맞지 않아질 수 있다.
무서운 잡음
때로는 Javadocs도 잡음이다.
함수나 변수로 표현할 수 있다면 주석을 달지 마라
위치를 표시하는 주석
배너 // Actions ///////////// 를 남용하면 독자가 흔한 잡음으로 여겨 무시한다.
닫는 괄호에 다는 주석
중첩이 심하고 장황한 함수라면 닫는 괄호에 주석을 다는 게 유용할 수도 있다.
하지만 작고 캡슐화된 함수에서는 잡음일 뿐으로, 주석을 다는 것보다 함수를 줄이려고 시도하도록 하자.
공로를 돌리거나 저자를 표시하는 주석
소스 코드 관리 시스템에 저장하는 편이 좋다.
주석으로 처리한 코드
주석으로 처리된 코드는 이유가 있어 남겨놓았을 것이라 여겨 지우기를 주저한다.(소름)
소스 코드 관리 시스템이 코드를 기억해주기 때문에 주석으로 처리할 필요가 없다.
HTML 주석
전역 정보
주석을 달아야 한다면 근처에 있는 코드만 기술하라.
코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
너무 많은 정보
주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 말자.
모호한 관계
주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
함수 헤더
짧고 한 가지만 수행하며 이름을 잘 붙인 함수 »> 주석으로 헤더를 추가한 함수
비공개 코드에서 Javadocs
공개하지 않을 코드라면 Javadocs는 쓸모가 없다.
유용하지 않을 뿐만 아니라 Javadocs 주석이 요구하는 형식으로 인해 코드만 보기 싫고 산만해진다.
내 생각
주석이 달려있으면 무조건 좋은 거라고 생각했는데 충격이었다..
나쁜 주석의 예제.. 대부분 해본 것들이라 마음이 아팠다…
위치를 표시하는 주석.. 처음에 보고 와 이렇게 좋은 주석이 있다니~~ 하고 따라 썼는데 ㅠㅠ…
주석이 없어도 잘 읽히는 함수를 짤 수 있도록 고민 또 고민해보는 개발자가 되자!!