[클린코드] 4. 주석

 

1. 로직에 대한 설명을 주석으로 담지 마라

주석은 나쁜 코드를 보안하지 못한다. 주석으로 설명해야만 하는 코드는 나쁜 코드이다. 리팩토링을 고려하라.

 

2. 날짜에 대한 리턴타입을 제공하는 주석은 달아라

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

 

3. 코드로 설명할 수 있으면 주석을 달지마라.

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

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