[Clean Code] 4장 주석

TIL (Today I Learned)

22.02.25~22.02.26

오늘 읽은 범위

4장 주석

책에서 기억하고 싶은 내용

우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

 

주석이 필요한 경우

- 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드 -> 의미를 명료하게 밝히는 주석

- 다른 프로그래머에게 결과를 경고할 목적

 

오해할 여지가 있는 주석

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

- this.closed가 true여야 메소드가 반환된다.

- timeout을 기다렸다 this.closed가 그래도 true가 아니면 예외를 던진다.

 

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

// before
if (smodule.getDependSubSystems().contains(susSysMod.getSubSystem()))

// after
ArrayList moduleDependees = smodule.getDependSubSystems();
String ourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))

 

전역 정보

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

 

오늘 읽은 소감

사실 아직까지는 더러운 주석을 많이 보지 못해서 관련 내용이 익숙하지 않았다. 하지만 오해할 여지가 있는 주석 같은 실수는 앞으로 얼마든지 일어날 수 있는 것 같기 때문에 주의해야겠다.

 

궁금하거나 잘 이해되지 않는 내용

정적 초기화 함수 = 정적 필드 초기화?

1) 선언과 동시에 초기화

2) static block을 이용한 초기화