About Clean Code Ch4

Clean Code에 대하여

in Clean Code by Robert C. Martin

Ch4 주석

나쁜 코드에 주석을 달지마라.
새로 짜라.
- 브라이언 W. 커니핸, P.J. 플라우거

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

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

코드로 의도를 표현하라!

if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))  
다음의 코드와 같이 바꾸는 것이 좋다.  
if(employee.isEligibleForFullBenefits())  

좋은 주석

어떤 주석들은 정말 필요하거나 유익하다.
하지만 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석 이다!

1. 법적인 주석 때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
   예를 들어, 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.

2. 정보를 제공하는 주석
   때로는 기본적인 정보를 주석으로 제공하면 편리하다.
   예를 들어, 다음 주석은 추상 메서드가 반환할 값을 설명한다.

   // 테스트 중인 Responder 인스턴스를 반환한다.  
   protected abstract Responder responderInstance();
   

때때로 위와 같은 주석이 유용하다 할지라도, 가능하면, 함수 이름에 정보를 담는 편이 더 좋다. 예를 들어, 위 코드는 함수 이름을 responderBeingTested로 바꾸면 주석이 필요없어진다.

1. 의도를 설명하는 주석
   때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다. 결정의 이유 등을 주석으로 설명하면 저자의 의도가 좀 더 분명해 질 수 있다.

2. 의미를 명료하게 밝히는 주석
   때때로 모호한 인수나 반환값은 그 의미를 읽기 표현하면 이해하기 쉬워진다.
   일반적으로는 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
   언제나 주석을 달 때는 더 나은 방법이 없는지 고민하고 정확히 달도록 각별히 주의한다.

3. 결과를 경고하는 주석
   때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
   예를 들어, 다음은 특정 테스트 케이스를 꺼야하는 이유를 설명하는 주석이다.

   // 여유 시간이 충분하지 않다면 실행하지 마십시오.  
   public void _testWithReallyBigFile()
   {...}
   

다음은 주석이 아주 적절한 예시이다.

public static SimpleDateFormat makeStandardHttpDateFormat()
{
    // SimpleDateFormat은 스레드에 안전하지 못하다.
    // 따라서 각 인스턴스를 독립적으로 생성해야 한다.  
    SimpleDateFormat ...
}

여기서는 주석이 아주 합리적이다.
프로그램 효율을 높이기 위해 정적 초기화 함수를 사용하려던 열성적인 프로그래머가 주석 때문에 실수를 면한다.

1. TODO 주석
   때로는 ‘앞으로 할 일’을 TODO 주석으로 남겨두면 편하다.
   이 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
   더 이상 필요없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용하다.
   하지만 어떤 용도로 사용하든 시스템에 나쁜 코드를 남겨 놓는 핑계가 되서는 안된다.

2. 중요성을 강조하는 주석
   자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다.

   String listItemContent = match.group(3).trim();
   // 여기서 trimdms 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.  
   // 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.
   

3. 공개 API에서의 주석
   설명이 잘된 공개 API는 참으로 유용하다.
   공개 API를 구현한다면 반드시 훌륭한 주석을 작성하라.

나쁜 주석

대다수 주석이 이 범주에 속한다.

1. 주절거리는 주석
   특별한 이유없이 의무감으로, 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다. 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.

2. 같은 이야기를 반복하는 주석
   만약 주석이 코드 내용을 그대로 중복한다면,
   자칫하면 코드보다 주석을 읽는 시간이 더 오래걸린다.

3. 오해의 여지가 있는 주석
   때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다. (코드보다 읽기도 어려운) 주석에 담긴 ‘살짝 잘못된 정보’ 로 인해 다른 프로그래머의 시간을 크게 낭비할 수 도 있다.

4. 의무적으로 다는 주석
   그저 의무적으로 주석을 달아야한다는 규칙은 어리석기 그지없다.
   이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.

5. 이력을 기록하는 주석
   때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가한다.
   그리하여 모듈 첫머리 주석은 지금까지 모듈에 가한 변경을 모두 기록하는 일종의 일지 혹은 로그가 된다.

6. 있으나 마나한 주석
   때때로 있으나 마나한 주석을 접한다.
   쉽게 말해, 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.

7. 함수나 변수로 표현할 수 있다면 주석을 달지 마라.
   적절한 변수명과 함수명으로 표현할 수 있다면 주석이 필요 없다!!!

8. 위치를 표시하는 주석
   때때로 프로그래머는 소스 파일에서 특정 위치를 표시하려 주석을 사용한다.
   하지만 역시나 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.

9. 닫는 괄호에 다는 주석
   때로는 프로그래머들이 닫는 괄호에 특수한 주석을 달아놓는다.
   중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만, (우리가 선호하는) 작고 캡슐화된 함수에는 잡음일 뿐이다. 그러므로 닫는 괄호에 주석을 달아야 겠다는 생각이 든다면 대신에 함수를 줄이려 시도하다.

10. 공로를 돌리거나 저자를 표시하는 주석
    이제는 소스 코드 관리 시스템이 모두 기억해준다!!
    이런 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.

11. 주석으로 처리한 코드
    이제는 삭제한 코드까지 모두 소스 코드 관리 시스템이 기억해준다.
    그러니 그냥 코드를 삭제하라.

12. HTML 주석
    소스 코드에서 HTML 주석은 혐오 그 자체다.
    HTML 주석은 편집기/IDE에서조차 읽기가 어렵다.

13. 전역 정보
    주석을 달아야 한다면 근처에 있는 정보만 기술하라.
    코드 이루에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.

14. 너무 많은 정보
    주석에다 흥미로운 역사나 관련없는 정보를 장황하게 늘어놓지 마라.

15. 모호한 관계
    주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
    이왕 공들여 주석을 달았다면 적어도 독자가 주석과 코드를 읽어보고 무슨 소린지 알아야 하지 않겠는가?

16. 함수 헤더
    짧은 함수는 긴 설명이 필요 없다.
    짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.