4장 주석 (이어서)

<aside> 💡 나쁜 주석 : 대다수 주석은 허술한 코드를 지탱하고, 엉성한 코드를 변명할 뿐이다

</aside>

1 주절거리는 주석

다음은 주석을 제대로 달았다면 유용했을 코드다.

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

catch 블록에 있는 주석은 다음과 같이 해석될 수 있다

1. loadProperties.load를 호출하기 전에 읽어들이는가?
2. loadProperties.load가 예외를 잡아 기본값을 읽은 후 예외를 던져주는가?
3. loadProperties load가 파일을 읽어 들이기 전에 기본값부터 읽는가?

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

3 오해할 여지가 있는 주석

4 이력을 기록하는 주석

소스코드 관리 시스템이 없을 당시에는, 필요한 장치였으나 지금은 혼란만 가중하므로 완전히 제거해야한다