Skip to content

Latest commit

 

History

History
501 lines (440 loc) · 20.7 KB

04 주석.md

File metadata and controls

501 lines (440 loc) · 20.7 KB
Raw

들어가면서

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

  • 잘 달린 주석은 그 어떤 정보보다 유용하다.
  • 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다.
  • 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼트려 해악을 미친다.

코드로 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않다.
즉, 우리는 코드로 의도를 표현하지 못해, 주석을 사용한다.
그러므로 주석이 필요하다면 상황을 역전해 코드로 의도를 표현할 방법은 없을까? 생각하자

코드는 변화하고 진화한다.
일부가 여기서 저기로 옮겨지기도 한다.
조각이 나뉘고 갈라지고 합쳐지면서 괴물로 변한다.
불행하게도 이때마다 주석은 코드의 의미를 지속해서 반영하기 힘들다.

그렇기 때문에 프로그래머들은 주석을 항상 관리하고 신경 써 줘야 하며
복구성, 관련성, 정확성이 언제나 높아야 한다고 주장하는 것일지도 모르겠다.
하지만, 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로 주석이 필요 없는 코드를 작성할 수 있다.

진실은 한 곳에만 존재한다. 바로 코드다.

코드만이 자기가 하는 일을 진실하게 말한다.
코드만이 정확한 정보를 제공하는 유일한 출처다.
그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
"이런! 이해가 되지 않으니 주석을 달아야겠다."가 아닌 코드를 정리할 생각을 하자.

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

코드로 의도를 표현하라!

if ((employee.flags & HOURLY_FLAG) && (employee.age > 65)){}

확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다.

if (employee.isEligibleForFullBenenfits()){}

하지만 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 된다.

좋은 주석

법적인 주석

// Copyright (C) 2003,2004,2005 by Object Metor, Inc. All rights reserved.
// GNU General Public License 버전 2 이상을 따르는 조건으로 배포한다.
  • 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
  • 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고 타당하다.
  • 소스 파일 첫머리에 들어가는 주석이 반드시 계약 조건이나 법적인 정보일 필요는 없다.
  • 모든 조항과 조건을 열거하는 대신에, 가능하다면, 표준 라이선스나 외부 문서를 참조해도 된다.

정보를 제공하는 주석

// kk:mm:ss EEE, MMM dd, yyyy 형식이다.   
pattern timeMatcher = Pattern.compile("\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*");
  • 코드에서 사용한 정규 표현식이 시각과 날짜를 뜻한다고 설명한다.
  • 하지만, 이왕이면 시각과 날짜를 변환하는 클래스를 만든다면 주석이 필요 없어질 것이다.
    • 이 부분에 대해서는 어떻게 클래스로 만들지 생각해봐야겠다.

의도를 설명하는 주석

public void testConcurrentAddWidgets() throws Exception {
    WidgetBuilder widgetBuilder = new WidgetBuilder(new Class[]{BoldWidget.class});
    String text = "'''bold text'''";
    Parent parent = new BoldWidget(new MockWidgetRoot(), "'''bold text'''");
    AtomicBoolean failFlag = new AtomicBoolean();
    failFlag.set(false);

    // 스레드를 대량 생성하는 방법으로 어떻게든 RaceCondition을 만들려 시도한다.  
    for(int i=0; i < 25000; i++){
         WidgetBuilderThread widgetBuilderThread = new WidgetBuilderThread(widgetBuilderThread, text, parent, failFlag);
         Thread thread = new Thread(widgetBuilderThread);
         thread.start();
    }
    assertEquals(false, failFlag.get());
}
  • 주석은 구현을 이해하게 도와주는 것을 넘어 결정에 깔린 의도까지 설명한다.
  • 문제를 해결한 방식에 동의하지 않을지도 모르지만 어쨌거나 의도는 분명히 드러난다.

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

public void tempCompareTo() throws Exception{
   WikikPage a = PathParse.parse("PageA");
   WikikPage ab = PathParse.parse("PageA.PageB");
   WikikPage b = PathParse.parse("PageB");
   WikikPage aa = PathParse.parse("PageA.PageA");
   WikikPage bb= PathParse.parse("PageB.PageB");
   WikikPage ba = PathParse.parse("PageB.PageA");

   assertTrue(a.compareTo(a) == 0)   // a == a
   assertTrue(a.compareTo(b) != 0)   // a != b
   assertTrue(a.compareTo(ab) == 0)  // ab == ab
   assertTrue(a.compareTo(b) == -1)  // a < a
   assertTrue(a.compareTo(ab) == -1) // aa < ab
   assertTrue(a.compareTo(bb) == -1) // ba < bb
   assertTrue(a.compareTo(a) == 1)   // b > a
   assertTrue(a.compareTo(aa) == 1)  // ab > aa
   assertTrue(a.compareTo(ba) == 1)  // bb > ba
}
  • 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
  • 인수나 반환값 자체를 명확하게 만들면 좋지만
    표준 라이브러리나 변경하지 못하는 코드라면 주석을 사용하는 것이 좋다.
  • 물론, 그릇된 주석을 달아놓을 위험은 상당히 높다.
  • 그러므로 위와 같은 주석을 달 때는 더 나은 방법이 없는지 고민하고 주의하자.

결과를 경고하는 주석

// 여유 시간이 충분하지 않다면 실행하지 마십시오   
public void _testWithReallyBigFile(){
    ...
}
  • 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
  • 시간이 없다면 해당 메서드를 실행시키지 않고 싶어하는 상황이다.
  • JUnit4가 나오기 전에는 메서드 이름 앞에 _ 기호를 붙이는 방법이 일반적인 관례였다.
  • 위에 제시한 주석은 다소 경박하지만 매우 효율적인 주석이다.
@Ignore("여유 시간이 충분하지 않다면 실행하지 마십시오")
public void testWithReallyBigFile(){
    ...
}
  • 최근에는 @Ignore 어노테이션을 이용해서 테스트 케이스를 끌 수 있다.
  • @Ignore("여유 시간이 충분하지 않다면 실행하지 마십시오")로 주석을 대신한다.

다른 적절한 예

public static SimpleDateFormat makeStandardHttpDateFormat(){
 
   // SimpleDateFormat 은 스레드에 안전하지 못하다.
   // 따라서 각 인스턴스를 따로 생성해야한다.   
   SimpleDateFormat df = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z");
   df.setTimeZone(TimeZone.getTimeZone("GMT"));
   return df;
}
  • 효율을 위해 정적 초기화 함수를 사용하려다 주석 덕분에 실수를 면할 수 있었다.

TODO 주석

// TODO-MoM 현재 필요하지 않다. 
// 체크아웃 모델을 도입하면 함수가 필요 없다.  
protected VersionInfo makeVersion() throws exception{
 return null;
}
  • 때로는 앞으로 시작할 일에 대한 주석을 남겨두면 편하다.
  • 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용하기 때문이다.
public class Sample extends SampleParent {
    
    // 상속을 통해 오버라이드한 메서드
    // 어떤 어떤 기능을 가진 메서드로 만들자
    @Override
    public void pleaseDefineMethodAction {
        return null;
    }
}
  • 아직 구현을 하지 않았고 상속이나 구현으로 인한 메서드 형태만 만들었을 경우
    만들고자 하는 기능을 주석으로 남겨두는 것이 좋다.
예시
더 이상 필요없는 기능을 삭제하라는 알림
누군가에게 문제를 봐달라는 요청
다 좋은 이름을 떠올려달라는 부탁
  • 코드 설명이 아닌 다른 개발자에게 부탁할 부가적인 용도의 주석은 나쁘지 않다.
  • 단, 나쁘지 않다는 것이지 주석이 없는 코드가 가장 좋으니 점검시 필요 없으면 삭제하자.

중요성을 강조하는 주석

String listItemContent = match.group(3).trim();
// 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.   
// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.   
new ListItemWidget(this, listItemContent, this.level +1);
return buildList(text.substring(match.end());
  • 대수롭지 않다고 여겨질 위험이 있는 중요한 코드를 위해 주석을 사용하기도 한다.

공개 API에서 JavaDoc

참고 : https://devist.tistory.com/112

설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다.
표준 자바 라이브러리에서 사용한 Javadoc이 좋은 예다.
Javadoc가 없다면 자바 프로그램을 짜기가 아주 어려웠을 것이다.
대부분 공개 API를 구현한다면 훌륭한 Javadoc을 작성하고 있다.
하지만, javadoc도 오도하거나, 잘못 위치하거나 그릇된 정보를 전달한 가능성이 존재한다.
그렇기 때문에 늘 신경을 쓰면서 작성을 해야한다.

나쁜 주석

주절 거리는 주석

public void loadProperties() {
    try {
        String propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE;
        FileInputStream propertiesStream = new FileInputStream(propertiesPath);
        loadedProperties.load(propertiesStream);
    } catch(IOException e) {
        // 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미이다.     
    }    
}
  • IOException 이 발생하면 속성 파일이 없다는 뜻이다.
  • 하지만, 누가 모든 값을 읽어들이는 것인가?
    • loadedProperties.load()전에 읽는 것인가?
    • loadedProperties.load()가 기본값을 읽은 후 예외를 던지는 것인가?
    • loadedProperties.load()가 파일을 읽기 전에 모든 기본값 부터 읽는 것인가?
  • 답을 알아내려면 다른 코드를 뒤져보는 수 밖에 없다.
  • 즉, 기존에 작성했던 주석은 무의미한 주석이었던 것이다.

저자만 이해할 수 있는 주석은 좋지가 않다.
타인이 해당 주석을 보더라도 다른 코드를 살펴봐야하기 때문이다.
그러므로 완벽히 대체 가능한 주석을 작성하는 것이 낫고
이보다 더 좋은 것은 주석을 달지 않게끔 프로그램을 작성하는 것이다.

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

// this.closed()가 true일 때 반환되는 유틸리티 메서드다.   
// 타임아웃에 도달하면 예외를 던진다.
pubilc synchronized void waitForClose(final long timeoutMills) throws Exception {
    if(!closed) {
        wait(timeoutMills);
        if(!closed) {
            throw new Exception("MockResponseSender could not be closed");
        }
    }
}
  • 코드의 내용을 중복으로 서술하는 주석은 좋지 않다.
  • 주석은 코드의 내용을 대신하더라도 어차피 주석을 읽고 코드를 읽으므로 불필요하다.

오해할 여지가 있는 주석

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

정보에 대해 오해의 여지가 있는 주석은 좋지가 않다.
사실 위 코드는 오해의 여지가 있다.

  • this.closed()가 true로 변하는 순간에 메서드는 반환되지 않는다.
  • this.closed()가 true여야 메서드는 반환된다.
  • 아니면 타임아웃을 기다렸다가 this.closed()가 true가 아니면 예외를 던진다.
  • 즉, 변하는 순간에 반환되는 것이 아니라 기존에 변해있거나 타임아웃 이후에 반환된다.

미묘한 차이일지라도 오해의 여지가 있는 주석은 매우 나쁜 주석이다.

의무적으로 다는 주석

/**
 *
 * @Param title CD 제목
 * @Param author CD 저자
 * @Param tracks CD 트랙 숫자
 * @Param durationInMinutes CD 길이(단위 : 분)
 */
public void addCD(String title, String author, int tracks, int durationMinutes) {
    CD cd = new CD();
    cd.title = title;
    cd.author = author;
    cd.tracks = tracks;
    cd.duration = durationMinutes;
    cdList.add(cd);
}
  • 모든 함수에 javadoc을 달거나 모든 변수에 주석을 다는 것은 어리석은 짓이다.
  • 오히려 주석이 많아질수록 관리는 물론 코드를 헷갈리게 할 가능성이 있다.

이력을 기록하는 주석

/**
 * 변경 이력 (11-Oct-2001부터)
 * _________________________
 * 11-Oct-2001 : 클래스를 다시 정리하고 새로운 패키지인
 *               com.jrefinery.date로 옮겼다.(DG);
 * 05-Nov-2001 : getDescription() 메서드를 추가했으며 
 *               NotableDate class를 제거했다. (DG);
 * 12-Nov-2001 : IBD가 setDescription() 메서드를 요구한다.
 *               Notable 클래스를 없앴다. (DG);
 * ....
 */
  • 과거에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 있었다.
  • 하지만 현재는 버전 관리 도구를 사용하기에 주석을 달지 않는 것이 바람직하다.

있으나 마나한 주석

/**
 * 기본 생성자
 */
protected AnnualDateRule() {
    ...
}
try {
    ...
} catch(Exception e) {
    // 예외가 발생하다니 이게 뭐람!  
}
  • 너무 당연한 사실을 기록해서 새로운 정보를 얻지 못한는 주석은 좋지가 않다.
  • 또한, 아무런 정보도 없는 불필요한 주석은 사용하지 않는 것이 좋다.

무서운 잡음

/* The name. */
private String name;

/* The version. */
private String version;

/* The licenceName. */
private String licenceName;
  • 때로는 javadoc도 잡음이다.
  • 위 코드는 단지 문서를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음일 뿐이다.

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

// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?   
if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))
  • 코드의 길이를 줄이기 위해 체이닝 기법을 이용했다.
  • 하지만 무리한 체이닝 기법으로 오히려 주석이 필요한 상황이 되었다.
  • 위 코드에서 주석을 없애고 다시 표현하면 다음과 같다.
ArrayList moduleDependees = smodule.getDependSubsystems();
String ourSubSystem = subSysMod.getSubSystem();
if(moduleDependees.contains(ourSubSystem))
  • 함수나 변수로 그리고 이름으로 표현할 수 있다면 주석을 달지 말자
  • 너무 많은 주석은 오히려 혼란만 가중한다.

위치를 표시하는 주석

public void method() {
    // actions /////////////
    
    System.out.println("ACTION");
    System.out.println("ACTION");
    
    // actions end ////////
    
    // wait ///////////////
    
    System.out.println("wait");
    
    // wait end ///////////
}
  • 때로는 배너를 이용해서 특정 기능을 모아놓는 경우가 있어 좋기도 하다.
  • 하지만, 주석은 가독성을 낮추는 작업이므로 반드시 필요할 때만 드물게 사용하자.

닫는 괄호에 닫는 주석

try {
    while(true){
        ...
    } // while
} // try
  • if, for, while 같이 코드가 길어 닫는 괄호에 주석으로 다는 경우가 있다.
  • 하지만, 주석을 코드와 같이 관리해야한다.
  • 차라리 코드의 길이를 줄이는 노력을 하는 것이 좋다.

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

/* 우재가 추가함 */
  • 작성자를 기록하면 코드가 이해되지 않을 때 물어볼 수 있지만 방치되는 경우가 많다.
  • 이제는 버전 관리 시스템을 이용하여 개발자를 찾아낼 수 있기에 사용하지 말자.

주석으로 처리한 코드

System.out.println("A");
// System.out.println("B"); --> 대체 코드
  • 주석을 처리한 코드만큼 밀삽스러운 관행은 없으니 절대 이런식으로 코드를 작성하지 말자.
  • 이제는 버전 관리 시스템을 이용하여 이전 상태로 되돌릴 수 있다.

HTML 주석

/*
 * 정합성 테스트를 수행하기 위한 과업 
 * 이 과업은 정확성 테스트를 수행해 결과를 출력한다.
 * </p>
 * <pre>
 * 용법 : 
 * &lt;taskdef name=&quot;execute-fitnesse-tests&quot;
 *     ......
 */
  • HTML 주석은 편집기/IDE에서 조차 읽기가 어렵다.
  • HTML 주석을 달아 웹 페이지를 올린다면 프로그래머가 아닌 도구가 책임을 지게된다.

전역 정보

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

  • 위 코드의 문제점 :
    주석은 기본 포트 정보를 기술했다.
    하지만 함수에서는 포트 기본값을 전혀 통제하지 않는다.
    즉, 주석은 아래 메서드의 주석이 아닌 시스템 어딘가에 있는 메서드의 주석이다.

  • 주석을 달아야 한다면 근처에 있는 코드에만 기술하자.

  • 또한 시스템의 전반적인 정보를 기술하지 않아야 된다.

  • 전반적인 정보는 코드를 통해서 이해할 수 있다.

너무 많은 정보

/*
 RFC 2045 - Multipurpose Internet Mail Extensions (MIME)
 1부: 인터넷 메시지 본체 형식
 6.8절. Base64 내용 전송 인코딩(Content-Transfer-Encoding)
 인코딩 과정은 입력 비트 중 24비트 그룹을 인코딩된 4글자로 구성된 출력 문자열로 표현한다.
 ...
 ...
 ...
 ...
 인코딩하니까 생각나는게 제가 LA에 있을때...
*/
  • 주석에 흥미로운 역사나 관련이 없는 정보를 정황하게 늘어놓지는 말자
  • 불필요한 정보일 뿐이다.

모호한 관계

/*
 * 모든 픽셀을 담을 만큼 충분한 배열로 시작한다. (여기에 필터 파이트를 더한다.)
 * 그리고 헤더 정보를 위해 200바이트를 더한다.   
 */
this.pngBytes = new byte[((this.width + 1) * this.height * 3) + 200];

  • 위 코드의 문제점 :
    필터 바이트란 무엇인가?
    +1과 관련이 있을까?
    아니면 *3과 관련이 있을까?
    아니면 둘다?
    한 픽셀이 한 바이트인가?
    200을 추가하는 이유는?

  • 주석과 코드 사이에는 관계가 명확해야한다.

  • 즉, 주석을 통해 더 이상 코드에 대해 추가적으로 설명하지 않아야한다.

  • 그렇지 않을 경우 주석을 이해를 못하고 또 다시 코드를 봐야하므로 주석의 필요가 없어진다.

함수 헤더

public void loadUserByLibrary(Library library) {
    this.user = library.getUser();
}
  • 짧고 한 가지만 수행하며 이름을 잘 붙인 함수는 주석이 필요없다.

비공개 코드에서 javadoc

/*
 * @Param something
 */
public void method(Something something) {
    ...
}
public void method(Something something) {
    ...
}
  • 공개 API는 javadoc을 통해 사용자의 이해를 돕는다.
  • 하지만, 공개되지 않는 코드에 굳이 javadoc을 작성할 필요는 없다.
  • 오히려 주석으로 인해 코드가 산만해질 뿐이다.