[Clean Code(클린 코드)] 4장 주석

 

본 게시글은 <Clean Code>를 학습한 내용을 정리한 글입니다. (문제시 삭제하겠습니다.)

 

Clean Code(클린 코드) - 교보문고

 

주석은 기껏해야 필요악이다. 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라.

주석이 필요한 상황에 처하면 곰곰히 생각하기 바란다. 상황을 역전해 코드로 의도를 표현할 방법은 없을까?

주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다. 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까.

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

 

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

• 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문
• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
• 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신 그 난장판을 깨끗이 치우는 데 시간을 보내라!

코드로 의도를 표현하라!

• 확실히 코드만으로 의도를 설명하기 어려운 경우가 존재하지만, 몇 초만 더 생각하면 대다수 의도를 표현할 수 있다
• 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.
• //직원에게 복지 혜택을 받을 자격이 있는지 검사한다. -> employee.isEligibleForFullBenefits()

좋은 주석

• 법적인 주석
  • 저작권 정보, 소유권 정보 등 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 놓으라고 명시
  • 요즘 IDE는 주석 헤더를 자동으로 축소해 코드만 깔끔하게 표시한다.
• 정보를 제공하는 주석
  • 때로는 기본적인 정보를 주석으로 제공하면 편리하다. (주석이 유용하더라도 함수 이름에 정보를 담으면 주석이 필요 없어짐)
  • 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명하는 주석 (시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 주석이 필요없어짐)
• 의도를 설명하는 주석
  • 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
• 의미를 명료하게 밝히는 주석
  • 일반적으로는 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
  • 물론 그릇된 주석을 달아놓을 위험은 상당히 높다. 주석이 올바른지 검증하기 쉽지 않다. 이것이 의미를 명료히 밝히는 주석이 필요한 동시에 주석이 위험한 이유이기도 하다.
  • 의미를 명료하게 밝히는 주석을 달 때는 더 나은 방법이 없는지 고민하고 정확히 달도록 각별히 주의한다.
• 결과를 경고하는 주석
  • 때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
  • 예를 들어, 특정 테스트를 꺼야하는 이유를 설명하는 주석이 있다. // 여유 시간이 충분하지 않다면 실행하지 마십시오.
• TODO 주석
  • ‘앞으로 할 일’을 //TODO 주석으로 남겨두면 편하다.
  • TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
  • 요즘 나오는 대다수 IDE는 TODO 주석 전부를 찾아 보여주는 기능을 제공하므로 주석을 잊어버릴 염려는 없다.
  • 그래도 TODO로 떡칠한 코드는 바람직하지 않기 때문에 주기적으로 점검해 없애도 괜찮은 주석은 없애라고 권한다.
• 중요성을 강조하는 주석
  • 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다.
• 공개 API에서 Javadocs
  • 설명이 잘 된 공개 API는 유용하고 만족스럽다. 표준 자바 라이브러리에서 사용한 Javadocs가 좋은 예다.
  • 하지만, 여느 주석과 마찬가지로 javadocs 역시 독자를 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재한다.

나쁜 주석

• 주절거리는 주석
  • 특별한 이유없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간 낭비
  • 주석을 달기로 결정했으면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.
• 같은 이야기를 중복하는 주석
  • 헤더에 달린 주석이 같은 코드 내용을 그대로 중복하는 경우. 자자칫하면 코드보다 주석을 읽는 시간이 더 오래 걸린다.
  • 실제로 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다.
• 오해할 여지가 있는 주석
  • 때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다.
  • 주석에 담긴 ‘살짝 잘못된 정보’로 인해 어느 프로그래머가 경솔하게 함수를 호출하여 성능 이슈 해결에 많은 시간을 할애할 문제가 생길수 있다.
• 의무적으로 다는 주석
  • 모든 함수에 javadocs를 달거나 모든 변수에 주석을 달아야한다는 규칙은 어리석기 그지없다. 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.
• 이력을 기록하는 주석
  • 예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했다. 하지만 소스 코드 관리 시스템이 잘 되어있는 요즘은 혼란만 가중할 뿐이다. 완전히 제거하는 편이 좋다.
• 있으나 마나 한 주석
  • 쉽게 말해, 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
• 무서운 잡음
  • 때로는 javadocs도 잡음이다. javadocs를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음으로 어떠한 목적도 제공하지 않는 주석이 달리기도 한다.
  • 잘라서 붙여넣기 오류가 발견되기도 한다.
• 함수나 변수로 표현할 수 있다면 주석을 달지 마라
  • 코드를 작성한 저자는 주석을 먼저 달고 주석에 맞춰 코드를 작성했을지도 모른다. 하지만 주석이 필요하지 않도록 코드를 개선하는 편이 더 좋다.
• 위치를 표시하는 주석
  • 때때로 프로그래머는 소스 파일에서 특정 위치를 표시하려 주석을 사용한다.
  • // Actions ////////// 와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있다.
  • 하지만 일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야 마땅하다.
  • 특히 뒷부분에 슬래시(/)로 이어지는 잡음은 제거하는 편이 좋다.
  • 너무 자주 사용하지 않는다면 배너는 눈에 띄며 주의를 환기한다. 그러므로 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다. 배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다.
• 닫는 괄호에 다는 주석
  • 중첨이 심하고 장황한 함수라면 의미가 있을지도 모르지만, 작고 캡슐화된 함수에는 잡음이다.
  • 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.
• 공로를 돌리거나 저자를 표시하는 주석
  • /* 릭이 추가함 */
  • 소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다. 저자 이름으로 코드를 오염시킬 필요가 없다.
  • 위와 같은 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.
• 주석으로 처리한 코드
  • 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안된다고 생각한다. → 쓸모없는 코드가 점차 쌓여간다.
  • 소스 코드 관리 시스템이 우리를 대신에 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다.
• HTML 주석
  • (javadocs와 같은) 도구로 주석을 뽑아 웹 페이지에 올릴 작정이라면 주석에 HTML 태그를 삽입해야 하는 책임은 프로그래머가 아니라 도구가 져야 한다.
• 전역 정보
  • 주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
• 너무 많은 정보
  • 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라. 독자에게 불필요하며 불가사의한 정보일 뿐이다.
• 모호한 관계
  • 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
  • 주석을 다는 목적은 코드만으로 설명이 부족해서다. 주석 자체가 다시 설명을 요구해서는 안된다.
• 함수 헤더
  • 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
• 비공개 코드에서 javadocs
  • 공개하지 않을 코드라면 javadocs는 쓸모가 없다.
  • 유용하지 않을 뿐만 아니라 javadocs 주석이 요구하는 형식으로 인해 코드만 보기 싫고 산만해질 뿐이다.