클린 코드 4장 - 주석

박진형·2022년 4월 15일
0

CleanCode

목록 보기
3/8

4장

이 장은 프로그래밍 언어 자체가 표현력이 풍부하다면 주석은 필요 없을 것이라고 말한다.
주석은 코드 표현의 실패를 의미한다. 이렇게나 저자가 주석을 무시하는 이유는 주석이 너무 자주 거짓말을하기 때문이다. 주석은 오래될수록 코드에서 멀어진다. 점점 유지 보수하기 어려워진다.

MockRequest request;
private final String HTTP_DATE_REGEXP = "[SMTWF][a-z]{2}\\,\\s[0-9] ...
private Response response;
private FitNesseContext context;
private FileResponder context;
private Locale saveLocale;
// Example: "Tue, 02 Apr 2003 22:18:49 GMT"

위 예제는 주석과 HTTP_DATE_REGEXP 사이에 새로운 필드들이 추가 됐음을 예상하고있다.
주석은 HTTP_DATE_REGEXP에 관한 내용이기 때문이다.

그러므로 주석은 엄격하게 관리 되어야하고, 복구성, 관련성, 정확성이 언제나 높아야한다.
하지만 저자는 주석을 쓰지 않는 방향으로 에너지를 쏟기를 권하고 있다.

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

코드에 주석을 포함하는 일반적인 이유는 코드의 품질이 나쁘기 때문이다.
표현력이 풍부하고 깔끔하여 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

코드로 의도를 표현하라!

// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flag & HOURLY_FLAG) && *employee.age > 65))

if (employee.isEligibleForFullBenefits())

위 코드에서 두 구문 중 아래쪽이 주석을 사용하지 않고도 의도를 더 잘 표현했다고 볼 수 있다.

좋은 주석

정말로 좋은 주석은 주석을 달지 않을 방법을 찾아낸 주석이다.
하지만 몇 가지 주석은 필요하거나 유익하다. 그런 좋은 주석은 다음과 같다.

- 법적인 주석

저작권 정보나 소유권 정보는 필요하고 타당하다.

//Copyright (C) 2003,2004,2005 by Object Mentor, Inc. Al;l rights reserved.
...

- 정보를 제공하는 주석

때로는 기본적인 정보를 주석으로 제공하면 편리하다.

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

하지만 위 주석이 유용할지라도 함수이름을 responderBeingTested로 바꾸면 주석이 필요 없어진다.

  • 예제 2
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile("\\d*:\\d*:\\d* \\w*,\\w* \\d*, \\d*");

위 코드를 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 깔끔해지며 주석이 필요 없어진다.

- 의도를 설명하는 주석

주석은 때로는 구현을 이해하게 도와주는 선을넘어 결정에 깔린 의도까지 설명한다.

ex) 두 객체를 비교할 때 다른 어떤 객체보다 자기 객체에 높은 우선 순위를 주기로 한 코드를 설명하는 주석

- 의미를 명료하게 밝히는 주석

일반적으로 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.

  • 예제
assertTrue(a.compareTo(a) == 0); // a == a
assertTrue(a.compareTo(b) != 0); // a != a
assertTrue(ab.compareTo(ab) == 0); // ab == ab

- 결과를 경고하는 주석

다른 프로그래머에게 결과를 경고할 목적으로 사용하기도 한다.

예를들어 "여유 시간이 충분하지 않다면 실행하지 마십시오." 라는 주석이 달린 테스트 케이스는
시간이 별로 없는 프로그래머에게 좋은 힌트가 될 수 있다.

- TODO 주석

'앞으로 할 일'을 //TODO 주석으로 남겨두면 편하다. TODO주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.

  • 더 이상 필요없는 기능 삭제하라는 알림
  • 누군가 문제를 봐달라는 요청
  • 더 좋은 이름을 떠올려 달라는 부탁
  • 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등

하지만 TODO로 떡칠한 코드는 바람직하지 않고 주기적으로 TODO주석을 점검해야한다.

- 중요성을 강조하는 주석

중요성을 강조하기 위해서도 주석을 사용한다.

- 공개 API에서 Javadocs

설명이 잘 된 공개 API는 유용하고 만족스럽다. 표준 자바 라이브러리에서 사용한 Javadocs가 좋은 예다. 하지만 여느 주석과 마찬가지로 잘못된 정보를 제공할 수 있다.

나쁜 주석

대다수의 주석이 이 범주에 속한다. 대다수의 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에 불과하다.

- 주절거리는 주석

  • 예제
public void loadProperties()
{
	try
	{
        String propertiesPath = propertiesLocation + "/" PROPERTIES_FILE;
        ...
	}
    catch(IOException e)
    {
    	//속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
    }
}

catch 블록에 있는 주석은 저자만알 수 있고 다른사람에게는 의미가 전달되지 않는다.

  • 누가 모든 기본값을 읽어 들이는가?
  • loadProperties.load를 호출하기 전에 읽어 들이는가?
  • loadProperties.load가 파일을 읽어 들이기 전에 모든 기본값부터 읽어 들이는가?
  • 저자가 catch 블록을 비워놓기 뭐해 몇마디 덧붙였을 뿐인가?
  • 아니면 나중에 기본값을 읽어 들이는 코드를 작성하려고 했는가?

알 수 없다. 코드를 뒤져봐야한다.
이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.

- 같은 이야기를 중복하는 주석

  • 예제
//this.closed가 true일 때 반환되는 유틸리티 메서드다.
//타임아웃에 도달하면 예외를 던진다.
public synchronized void waitForClose(final long timeoutMillis) throws Exception {
if(!closed)
{
	wait(timeoutMillis);
    if(!closed)
      	throw new Exception("MockReponseSender could not be closed");
    }
}

위 코드는 코드보다 주석이 더 많은 정보를 제공하지 못하며 같은 얘기를 반복하고 있다.

- 오해할 여지가 있는 주석

위 예제에서 this.closed가 true로 변하는 순간에 메서드는 반환되지 않는다.
this.closed가 true여야 메서드가 반한되고 아니라면 타임아웃을 기다렸다 this.closed가 그래도 true가 아니라면 예외를 던진다.
주석은 이 상황을 설명하지 못하고 있어서 어떤 프로그래머는 잘못 이해한채 이 함수를 사용할 수 있다.

- 의무적으로 다는 주석

무조건 모든 함수에 Javadocs를 넣으라는 규칙은 옳지 않다. 오히려 코드만 헷갈리게 만들며 잘못도니 정보를 제공할 여지만 만든다.

- 이력을 기록하는 주석

예전에는 소스 코드 관리 시스템이 없었으므로 주석에 수정 이력을 기록했다. 하지만 지금은 주석에 수정 이력을 기록하는 것은 좋지 않다.

- 있으나 마나 한 주석

/**
* 기본생성자
**/
protected AnnualDateRule{}

/** 월 중 일자 */
private int dayOfMonth;

/**
* 월 중 일자를 반환한다.
*
* @return 월 중 일자
*/
public int getDayOfMontH() {
	return dayOfMonth;
}

주석을 달기보다는 함수를 분리 하거나, 네이밍을 명확히 하거나 코드 구조를 개선하는 것이 더 좋다.

- 무서운 잡음

때로는 Javadocs도 잡음이다. Javadocs를 사용한다면 철저히 관리하자.

- 함수나 변수로 표현할 수 있다면 주석을 달지 마라

  • 예제
// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if(smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))
  • 개선
ArrayList moduleDependees = smodule.getDependSubsystems();
String oourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubsystem))

주석을 사용하지 않고도 코드를 잘 표현할 수 있다.

- 위치를 표시하는 주석

소스 파일에서 특정 위치를 표시하기 위해 주석 사용하는 경우

ex)

// Actions /////////////////////////

눈에 띄며 주의를 환기하는 역할을 하지만필요할 때만, 아주 드물게 사용하는 편이 좋다.
배너를 남용하면 독자가 흔한 잡음으로 여기고 무시할 수도 있다.

- 닫는 괄호에 다는 주석

닫는 괄호에 주석을 다는 것 보다는 중첩을 줄이고 함수를 줄이려고 시도를 하는게 좋다.

- 공로를 돌리거나 저자를 표시하는 주석

/* 릭이 추가함 */

이런 주석은 오랫동안 방치되고 점차 부정확해진다. 이러한 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.

- 주석으로 처리한 코드

주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.

  • 이유가 있어서 남겨놓았겠지
  • 중요하니까 지우면 안되겠지

이러한 이유 때문에 점점 불필요한 코드가 쌓이게 된다.

소스코드 관리 시스템은 우리를 대신해 코드를 기억해준다. 과감하게 지우자.

- HTML 주석

혐오 그 자체라고한다. HTML 주석은 주석을 읽기 좋아야하는 IDE에서 조차도 읽기가 어렵다.

- 전역 정보

주석을 달아야 한다면 근처에 있는 코드만 기술해야한다. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 말아야 한다.

/*
*  적합성 테스트가 동작하는 포트 : 기본값은 <b>8082</b>.
*
* @param fitnessePort
*/
public void setFitnessePort(int fitnessePort)
{
	this.fitnessPort = fitnessePort;
}

이 함수는 포트의 기본값을 통제하지 못한다. 만약 기본 포트값이 변경되었다면 이 주석도 맞춰서 변경될 것이라는 보장이 없고 잘못된 정보를 제공할 수 있다.

- 너무 많은 정보

주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘여놓지 말자.

- 모호한 관계

주석과 주석이 설명하는 코드는 둘 사이 관계가 명확해야 한다.
독자가 주석과 코드를 읽어보고 무슨 소린지 알아야 한다.

/*
* 모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다.).
*  ...
*/
this.pngBytes = new byte[((this.width + 1) * this.height * 3) + 200];
  • 여기서 필터 바이트는 무엇인가? +1? *3?
  • 한 픽셀이 한 바이트인가?
  • 200을 추가하는 이유는 무엇일까?

주석 자체가 다시 설명을 요구하고 있다.

- 함수 헤더

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

- 비공개 코드에서 Javadocs

Javadocs는 유용하지만 공개하지 않을 코드에 Javadocs는 쓸모 없다.

0개의 댓글