4장 주석

클린 코드 4장을 요약한 내용 입니다.

주석은 '순수하게 선하지' 못하다. 사실상 주석은 기껏해야 필요악이다. 프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않을것이다.

우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. 주석은 언제나 실패를 의미한다. 때때로 주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다.

주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다.

• 상황을 적전해 코드로 의도를 표현할 방법은 없을까?

• 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.

왜 주석을 부정적으로 생각할까..?

• 주석은 너무 자주 거짓말을 한다.

• 주석은 오래될수록 코드에서 멀어진다.

• 주석을 유지하고 보수하기란 현실적으로 불가능하다.

http://www.etoland.co.kr/plugin/mobile/board.php?bo_table=etohumor01&wr_id=1915952

주석도 코드다.

프로그래머들이 주석을 엄격하게 관리해야 한다고, 그래서 복구성과 관련성과 정확성이 언제나 높아야 한다고 주장할지도 모른다. 그 의견에 동의한다. 프로그래머들에게도 절도가 필요하다. 하지만 나라면 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요 없는 방향으로 에너지를 쏟겠다.

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

• 부정확한 주석은 독자를 현혹하고 오도한다.

• 더 이상 지킬 필요가 없는 규칙이나 지켜서는 안 되는 규칙을 명시한다.

진실은 한곳에만 존재한다.

https://m.blog.naver.com/PostView.nhn?blogId=bookaholic_suulsool&logNo=221316198855&proxyReferer=https%3A%2F%2Fwww.google.com%2F

바로 코드다.

• 코드만이 자기가 하는 일을 진실되게 말한다.

• 코드만이 정확한 정보를 제공하는 유일한 출처다.

• 그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 모듈을 짜고 보니 짜임새가 엉망이고 알아먹기 어렵다. 지저분한 모듈이라는 사실을 자각한다.

https://twitter.com/spectator1249/status/1279950008398147584?lang=el

그래서 자신에게 이렇게 말한다. " 이런! 주석을 달아야겠다! 아니다! 코드를 정리해야 한다!

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

코드로 의도를 표현하라

확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다. 하지만 이는 분명히 잘못된 생각이다. 다음 코드 예제 두 개를 살펴보자.

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

그렇다면 다음 코드는 어떤가?

if (employee.isEligibleForFullBenefits())

몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다. 조건이 많은 경우에는 달려는 설명을 별도 함수로 만들어 표현해도 충분하다.

좋은 주석

어떤 주석은 필요하거나 유익하다.

법적인 주석

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

// Copyright (C) 2003,2004 by Object Mentor, Inc. All rights reserved
// GNU General Public License 버전 2 이상을 따르는 조건으로 배포한다. 

정보를 제공하는 주석

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

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

하지만 가능하다면 함수 이름에 정보를 담는 편이 더 좋다. 다음은 좀 더 나은 예제다.

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

위에 제시한 주석은 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명한다. 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔하겠다.

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

때때로 모로한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.

public void testCompareTo() throws exception
{
    WikiPagePath a = PathParser.parse("PageA");
    WikiPagePath ab = PathParser.parse("PageA.PageB");
    WikiPagePath b = PathParser.parse("PageB");
    WikiPagePath aa = PathParser.parse("PageA.PageA");
    WikiPagePath bb = PathParser.parse("PageB.PageB");
    WikiPagePath ba = PathParser.parse("PageB.PageA");

    assertTrue(a.compareTo(a) == 0); // a == a
    assertTrue(a.compareTo(b) != 0); // a != b
    assertTrue(ab.compareTo(ab) == 0); // ab == ab
    ...
}

물론 그릇된 주석을 달아놓을 위험은 상당히 높다. 직전 예제를 살펴보면 알겠지만, 주석이 올바른지 검증하기 쉽지 않다.

결과를 경고하는 주석

때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.

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

물론 요즘에는 @Ignore 속성을 이용해 테스트 케이스를 꺼버린다.

TODO 주석

때로는 '앞으로 할 일'을 //TODO 주석으로 남겨두면 편하다.

// TODO-MdM 현재 필요하지 않다. 
// 체크아웃 모델을 도입하면 함수가 필요 없다. 
protected VersionInfo makeVersion() throws Exception
{
		return null;
}

TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.

나쁜 주석

대다수 주석이 이 범주에 속한다. 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.

주절거리는 주석

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

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

catch 블록에 있는 주석은 무슨 뜻일까? 확실히 저자에게야 의미가 있겠지만 그 의미가 다른 사람들에게는 전해지지 않는다.

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

헤더에 달린 주석이 같은 코드 내용을 그대로 중복한다. 자칫하면 코드보다 주석을 읽는 시간이 더 오래 걸린다.

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

코드를 정당화하는 주석도 아니고, 의도나 근거를 설명하는 주석도 아니다. 코드보다 읽기가 쉽지도 않다.

의무적으로 다는 주석

모든 함수에 javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.

/**
*
* @param title CD 제목
* @param author CD 저자
* @param tracks CD 트랙 숫자
* @param durationInMinutes CD 길이(단위: 분)
*/
public void addCD(Strng title, String author, 
                  int tracks, int durationInMinutes) {
    CD cd = new CD();
    cd.title = title;
    cd.author = author;
    cd.tracks = tracks;
    ....                  
}

이력을 기록하는 주석

모듈 첫머리에 지금까지 모듈에 가한 변경을 모두 기록하는 일종의 일지 혹은 로그를 적는 경우가 있다.

/**
* 변경 이력 (11-10-2001부터)
* ------------------------
* 11-10-2001 : 클래스를 다시 정리하고 새로운 패키지인
*              com.jrefinery.date 로 옮겼다 (DG);
*

당시에는 소스 코드 관리 시스템이 없었지만 현재는 다양한 버전 관리 툴이 존재하기 때문에 혼란만 가중할 뿐이다.

있으나 마나 한 주석

때때로 너무나 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이 있다.

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

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

다음 코드를 살펴보자

// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))

코드를 작성한 저자는 주석을 먼저 달고 주석에 맞춰 코드를 작성했을지도 모른다. 이제 주석을 없애고 다시 표현해보자.

ArrayList moduleDependees = smodule.getDependSubsystems();
String ourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))

이처럼 주석을 달기보다는 단계를 나눠서 코드를 개선하는 편이 더 좋다.

닫는 괄호에 다는 주석

때로는 프로그래머들이 닫는 괄호에 주석을 달아놓는다. 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화된 함수에는 잡음일 뿐이다.

public class wc {
   public static void main(String[] args) {
     BufferedReader in = new BufferedReader(new InputStreamReader(System.in));
     String line;
     int lineCount = 0;
     int charCount = 0;
     int wordCount = 0;
     try {
       while ((line = in.readLine()) != null) {
         lineCount++;
         charCount += line.length();
         String words[] = line.split("\\\\W");
         wordCount += words.length;
       } //while
       System.out.println("wordCount = " + wordCount);
       System.out.println("lineCount = " + lineCount);
       System.out.println("charCount = " + charCount);
     } // try
     catch (IOException e) {
       System.err.println("Error:" + e.getMessage());
     } //catch
   } //main
 }

주석으로 처리한 코드

주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.

this.bytePos = writeBytes(pngIdBytes, 0);
//hdrPos = bytePos;
writeHeader();
writeResolution();
//dataPos = bytePos;

두 행을 주석으로 처리한 이유가 무엇을까?

• 중요해서?

• 코드를 급박하게 변경했다는 사실을 알려주려고?

• 수년 전에 누군가 주석으로 처리한 코드를 아무도 없애지 않아서?

소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라

너무 많은 정보

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

/*
	해당 메소드는 회원가입용 메소드로 다양한 회원들의 정보를 전달받아 데이터베이스에 저장해준다. 
	회원 가입시 이메일 검증을 진행하고, 전화번호를 검증한다. 
	또한, ....
*/
public void register(Member member) { ... }