더북(TheBook)

3.1 지나치게 많은 주석 없애기

class Inventory {
    // 필드(하나만 있음)
    List<Supply> supplies = new ArrayList<>(); // 제품 리스트

    // 메서드
    int countContaminatedSupplies() {
        // TODO: 필드가 이미 초기화되었는지(널이 아닌지) 검증한다

        int contaminatedCounter = 0; // 카운터 
        // 제품이 없으면 변질도 없다는 뜻이다
        for (Supply supply : supplies) { // FOR 시작
            if (supply.isContaminated()) { 
                contaminatedCounter++; // 카운터를 증가시킨다!
            } // 제품이 변질되었으면 IF 끝
        }// FOR 끝

        // 변질된 제품 개수를 반환한다.
        return contaminatedCounter; // 유의해 처리한다!
    }
} // Inventory 클래스 끝

주석이 얼마나 중요한지 한 번쯤 들어보았을 거예요. 맞는 말이지만 중요한 정보(이유)를 설명할 때만 그렇습니다. 그렇지 않으면 방해만 될 뿐이죠.

위 코드는 앞의 몇몇 예제에서 보았던 Inventory 클래스를 보여줍니다. 녹색 텍스트를 보면 알 수 있듯이 주석이 너무 많이 들어 있습니다.

신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.