Skip to content

Latest commit

 

History

History
338 lines (182 loc) · 10.3 KB

ch4_comment.md

File metadata and controls

338 lines (182 loc) · 10.3 KB

주석(Comment)

나쁜 코드에 주석을 달지 마라. 새로 짜라.

잘 달린 주석은 그 어떤 정보보다 유용하다. 하지만 경솔하고 근거없는 주석은 코드를 이해하기 어렵게 만든다.

우리는 코드로 의도를 표현하지 못해, 그러니깐 실패를 만회하기 위해 주석을 사용한다. 그러므로 주석이 필요한 상황에 처하면 상황을 역전해 '코드로 의도를 표현할 방법은 없을까?' 생각 하자.

주석이 좋지 않은 이유

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

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

코드는 변화하고 진화한다. 주석은 코드를 따라가지 못한다.

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다. 진실은 한 곳에만 존재한다. 바로 코드다.

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

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

자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에, 그 난장판을 깨끗이 치우는 데 시간을 보내라 !

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.

코드로 의도를 표현하라

  • 개선 전
// 직원에게 복지혜택을 받을 자격이 있나 검사
if((employee.flags & HOURLY_FLAG) && 
		employee.age > 65)
  • 개선 후
if(employee.isEligibleForFullBenefits())

몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.

많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

좋은 주석

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

하지만 명심하길 바란다. 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을 !

법적인 주석

Ex. 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보

// Copyright (C) 2003,3004,2005 by Object Mentor, Inc. All rights reserved.

정보를 제공하는 주석

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

Ex. 다음 주석은 추상 메서드가 반환할 값을 설명한다.

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

하지만, 때때로 이와같은 주석이 유용하다 할지라도, 가능하다면 함수명에 정보를 담는 것이 좋다.

위 코드는 함수 이름을 responderBeingTested 로 바꾸면 주석이 필요 없어진다.

의도를 설명하는 주석

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

// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다. 
for (int i = 0; i < 25000; i++){
  스레드 생성
}

문제를 해결한 방식에 동의하지 않을지도 모르지만 어쨌거나 프로그래머의 의도는 분명히 드러난다.

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

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

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

assertTrue(a.compareTo(a) == 0);  // a == a
assertTrue(a.compareTo(b) != 0);  // a != b
assertTrue(ab.compareTo(ab) == 0);  // ab == ab
assertTrue(a.compareTo(b) == -1);  // a < a
assertTrue(b.compareTo(a) == -1);  // b > a
assertTrue(aa.compareTo(aa) == -1);  // aa < aa

물론 그릇된 주석을 달아놓을 위험은 상당히 높다. 이것이 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유이기도 하다. 그러므로 위와같은 주석을 달 때는 더 나은 방법이 없는지 고민하고 정확히 달도록 각별히 주의한다.

결과를 경고하는 주석

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

public static SimpleDateFormat makeStandarHttpDateFormat(){
	// SimpleDateFormat은 스레드에 안전하지 못하다.
	// 따라서 각 인스턴스를 독립적으로 생성해야 한다. 
	SimpleDateFormat df = new SimpleDateFormat("EEE, dd MMM  yyyy HH:mm:ss z");
	df.setTimeZone(TimeZone.getTimeZone("GMT"));
	return df; 
}

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

TODO 주석

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

주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애라.

중요성을 강조하는 주석

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

공개 API에서 Javadocs

설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다. 표준 자바 라이브러리에서 사용한 Javadocs가 좋은 예다.

공개 API를 구현한다면 반드시 훌륭한 Javadocs를 작성한다.

나쁜 주석

대다수 주석이 여기에 속한다.

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

주절거리는 주석

답을 알아내려면 다른 코드를 뒤져봐야 하는,

이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.

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

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

오해할 여지가 있는 주석

(코드보다 읽기 어려운) 주석에 담긴 '살짝 잘못된 정보'

의무적으로 다는 주석

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

이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초례한다.

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

이력을 기록하는 주석

모듈 첫머리에 모듈에 가한 변경을 모두 기록하는 일종의 일지 혹은 로그.

완전히 제거하는 것이 좋다.

있으나 마나 한 주석

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

// 기본 생성자
protected Dog(){
}

위치를 표시하는 주석

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

반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다. 남용하면 독자가 흔한 잡음으로 여겨 무시한다.

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

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

주석을 없애고 다시 표현하면

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

주석이 필요하지 않도록 코드를 개선하는 편이 더 좋다.

닫는 괄호에 다는 주석

중첩이 심하고 장황환 함수라면 의미가 있을지도 모르지만 (우리가 선호하는) 작고 캡슐화된 함수에는 잡음일 뿐이다.

닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.

try{
  while((line = in.readLine) != null){
    lineCount++;
    charCount += line.length();
    String words[] = line.split("a");
    wordCount += words.length;
  } //while
  System.out.println("wow");
  System.out.println("wow");
  System.out.println("wow");
} //try

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

/* 태임이가 추가함 */

주석이 있으면 다른 사람들이 코드에 관해 누구한테 물어볼지 아니까 위와 같은 주석이 유용하다 여길지도 모르겠다.

하지만 현실적으로 이런 주석은 그냥 오랫동안 방치되어 점차 부정확하고 쓸모없는 정보로 변하기 쉽다. 위와 같은 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.

주석으로 처리한 코드

주석으로 처리한 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각한다. 그래서 쓸모 없는 코드가 점차 쌓여간다.

HTML 주석

소스코드에서 HTML 주석은 혐오 그 자체다.

전역 정보

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

너무 많은 정보

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

모호한 관계

주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.

여기서 필터바이트란 무엇일까? +1과 관련이 있을까? 아니면 *3과 관련이 있을까? 아니면 둘 다? 200을 추가하는 이유는?

주석을 다는 목적은 코드만으로 설명이 부족해서다. 하지만, 주석 자체가 다시 설명을 요구하니 잘못된 주석이다.

함수 헤더

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

비공개 코드에서 Javadocs

공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.