[Study][CleanCode - 4] 17. 냄새와 휴리스틱

📋 목차.

17. 냄새와 휴리스틱
    .주석
    .환경
    .함수
    .일반
    .자바
    .이름
    .테스트
    .결론

---

✔️ 내용.

 

17. 냄새와 휴리스틱

 

 마틴 파울러는 'Refactoring'에서 다양한 코드 냄새를 거론한다. 이 장의 목록에서는 마틴이 맡은 냄새에 저자가 맡은 냄새를 추가한다. 또한 코드를 짜면서 사용하는 기교와 휴리스틱도 포함한다.
 아래 목록들은 '왜?'라고 자문한 다음 답을 기록하였다.

---

.주석

 

- C1: 부적절한 정보

 

 다른 시스템에 (VCS, 버그 추적 시스템 등) 저장할 정보는 주석으로 적절하지 못하다. 변경 이력, 날짜 등은 소스 코드만 번잡하게 만든다. 일반적으로 작성자, 최종 수정일, SPR(Software Problem Report) 번호 등과 같은 메타 정보만 주석으로 넣는다. 주석은 코드와 설계에 기술적인 설명을 부연하는 수단이다.

 

---

 

- C2: 쓸모없는 주석

 

 오래 된 주석, 엉뚱한 주석, 잘못된 주석은 더 이상 쓸모없다. 쓸모 없어질 주석은 아예 달지 않는 편이 가장 좋다.

 

---

 

- C3: 중복된 주석

 

 코드만으로 충분한데 구구절절 설명하는 주석이 중복된 주석이다. 주석은 코드만으로 다하지 못하는 설명을 부연한다.

 

---

 

 - C4: 성의 없는 주석

 

 작성할 가치가 있는 주석은 잘 작성할 가치도 있다. 주석을 달 참이라면 최대한 시간을 들여 정성껏 간결 명료하게 작성하자.

 

 

---

 

 - C5: 주석 처리된 코드

 

 주석으로 처리된 코드를 발견하면 즉각 지워버려라. 소스 코드 관리 시스템(Git, SVN 등) 이 기억하니까. 누군가 정말 필요하다면 이전 버전을 가져오면 되니까. 주석으로 처리된 코드를 내버려 두지 마라

 

 

---

 

.환경

 

 - E1: 여러 단계로 빌드해야 한다.

 

  빌드는 간단히 한 단계로 끝나야 한다. 온갖 jar, xml 파일 등 시스템에 필요한 파일을 찾느라 여기저기 뒤적일 필요가 없어야 한다. 한 명령으로 전체를 체크아웃해서 한 명령으로 빌드할 수 있어야 한다.

 

---

 

 - E2 : 여러 단계로 테스트해야 한다.

 

 모든 단위 테스트는 한 명령으로 돌려야 한다. IDE에서 버튼 하나로 모든 테스트를 돌린다면 가장 이상적이다. 모든 테스트를 한 번에 실행하는 능력은 아주 근본적이고 아주 중요하다. 따라서 그 방법이 빠르고, 쉽고, 명백해야 한다.

---

 

.함수

 

 - F1: 너무 많은 인수

 

함수에서 인수 개수는 작을수록 좋다.

 

 

---

 

 - F2: 출력 인수 

 

 출력 인수는 직관을 정면으로 위배한다. 일반적으로 독자는 인수를(출력 X) 입력으로 간주한다. 함수에서 뭔가의 상태를 변경해야 한다면 함수가 속한 객체의 상태를 변경한다.

 

---

 

 - F3: 플래그 인수

 

boolean 인수는 함수가 여러 기능을 수행한다는 명백한 증거이다. 함수는 하나의 기능만 을 가져야 한다.

 

---

 

 - F4: 죽은 함수

 

 아무도 호출하지 않는 함수는 삭제한다. 죽은 코드는 낭비다.

---

 

.일반

 

 - G1: 한 소스 파일에 여러 언어를 사용한다.

 

 오늘날 프로그래밍 환경은 한 소스 파일 내에서 다양한 언어를 지원한다. 예로 XML, HTML, YAML, Javascript 등 을 포함한다. 이상적으로는 소스 파일 하나에 언어 하나만 사용하는 방식이 가장 좋다. 현실적으로는 여러 언어가 불가피하다. 하지만 최대한 줄이도록 하자.

 

---

 

 - G2: 당연한 동작을 구현하지 않는다.

 

 최소 놀람의 원칙 (The Principle of Least Surprise)에 의거해 함수나 클래스는 다른 프로그래머가 당연하게 여길 만한 동작과 기능을 제공해야 한다. 당연한 동작을 구현하지 않으면 코드를 읽거나 사용하는 사람이 코드에 신뢰성을 잃어버리게 된다.

 

---

 

 - G3: 경계를 올바로 처리하지 않는다.

 

 코드는 올바로 동작해야 한다. 스스로의 직관에 의존하지 마라. 모든 경계 조건을 찾고, 테스트하는 테스트 케이스를 거쳐 올바르게 동작하는 코드를 작성한다.

 

 

---

 

- G4: 안전 절차 무시

 

 안전 절차를 무시하면 위험하다. 실패하는 테스트 케이스를 일단 제쳐두고 나중으로 미루는 태도는 신용카드가 공짜 돈이라는 생각만큼 위험하다.

 

---

 

 - G5: 중복

 

 이 책에 나오는 가장 중요한 규칙 중 하나이므로 심각하게 숙고하기 바란다. DRY(Don't Repeat Yourself) 원칙

코드에서 중복을 발견할 때마다 추상화할 기회로 간주하라. 중복된 코드를 하위 루틴이나 다른 클래스로 분리하라. 이렇든 추상화로 중복을 정리하면 설계 언어의 어휘가 늘어난다. 다른 프로그래머들이 그만큼 어휘를 사용하기 쉬워진다. 추상화 수준을 높였으므로 구현이 빨라지고 오류가 적어진다.

 

 - 똑같은 코드가 여러 나오는 중복은 간단한 함수로 교체한다.

 - 여러 모듈에서 일련의 조건문으로 똑같은 조건을 확인하는 중복은 다형성으로 대체한다.

 - 알고리즘이 유사하거나 코드가 서로 다른 중복일 경우, Template Method 패턴이나 Strategy 패턴으로 중복을 제거한다.

 

 최근 15년 간 나온 디자인 패턴의 대다수는 중복을 제거하는 잘 알려진 방법에 불과하다. BCNF(Boyce-Code Nomal Form) 역시 데이터베이스 스키마에서 중복을 제거하는 전략이다.

 

 가장 중요한 건. 어디서든 중복을 발견하면 없애라

 

---

 

 - G6: 추상화 수준이 올바르지 못하다.

 

 추상화는 저 차원 상세 개념에서 고차원 일반 개념을 분리한다. 추상화로 개념을 분리할 때는 철저해야 한다. 모든 저차원 개념은 파생 클래스에 넣고, 모든 고차원 개념은 기초 클래스에 넣는다.

 예로 세부 구현과 관련한 상수, 변수, 유틸리티 함수는 파생 클래스에 넣어야 한다. 기초 클래스는 구현 정보에 무지해야 마땅하다.

 소스 파일, 컴포넌트, 모듈도 마찬가지다. 우수한 설계자는 개념을 다양한 차원으로 분리해 다른 컨테이너에 넣는다. 

 

추상화는 소프트웨어 개발자에게 가장 어려운 작업 중 하나이다.

 

---

 

 

 - G7: 기초 클래스가 파생 클래스에 의존한다.

 

개념을 기초 클래스와 파생 클래스로 나누는 가장 흔한 이유는 고차원 기초 클래스 개념을 저 차원 파생 클래스 개념으로부터 분리해 독립성을 보장하기 위해서다. 그러므로 기초 클래스가 파생 클래스를 사용한다면 문제가 있다. 일반적으로 기초 클래스는 파생 클래스를 아예 몰라야 마땅하다.

 물로 예외가 있다. 간혹 파생 클래스 개수가 확실히 고정되었다면 기초 클래스에 파생 클래스를 선택하는 코드가 들어간다. 

 

---

 

 - G8: 과도한 정보

 

 잘 정의된 모듈은 인터페이스가 아주 작다. 잘 정의된 인터페이스는 많은 함수를 제공하지 않는다. 그래서 결합도가 낮다. 

클래스나 모듈 인터페이스에 노출할 함수를 제한할 줄 알아야 한다. 클래스가 제공하는 메서드 수는 적을수록 좋다. 함수가 아는 변수 수도 작을수록 좋다. 클래스에 들어있는 인스턴스 변수 수도 작을수록 좋다.

 자료를 숨겨라. 유틸리티 함수를 숨겨라. 상수와 임시 변수를 숨겨라. 메서드나 인스턴스 변수가 넘쳐나는 클래스는 피하라. 하위 클래스에서 필요하다는 이유로 protected 변수나 함수를 마구 생성하지 마라. 인터페이스를 매우 작게 그리고 매우 깐깐하게 만들어라. 정보를 제한해 결합도를 낮춰라

 

---

 

 - G9: 죽은 코드

 

 죽은 코드란 실행되지 않는 코드를 가리킨다. 불가능한 조건, 아무도 호출하지 않는 유틸리티 함수 등이 있다. 죽은 코드를 발견하면 시스템에서 제거하라.

---

 

 - G10: 수직 분리

 

 변수와 함수는 사용되는 위치에 가깝게 정의한다. 지역 변수는 처음으로 사용하기 직전에 선언하며 수직으로 가까운 곳에 위치해야 한다. 선언한 위치로부터 몇백 줄 아래에서 사용하면 안 된다.

  비공개 함수는 처음으로 호출한 직후에 정의한다. 비공개 함수는 전체 클래스 범위에 속하지만 그래도 정의하는 위치와 호출하는 위치를 가깝게 유지한다. 비공개 함수는 처음으로 호출되는 위치를 찾은 후 조금만 아래로 내려가면 쉽게 눈에 띄어야 한다.

 

---

 

 - G11: 일관성 부족

 

 어떤 개념을 특정 방식으로 구현했다면 유사한 개념도 같은 방식으로 구현한다. 앞서 언급한 최소 놀람의 원칙(The Principle of Least Surprice'에도 부합한다. 표기법은 신중하게 선택하며, 선택한 표기법은 신중하게 따른다.

 일관성은 코드를 읽고 수정하기 대단히 쉬워지게 한다.

 

---

 

 - G12: 잡동사니

 

 비어 있는 기본 생성자가 왜 필요한가? 필요 없는 변수, 함수, 주석은 제거하라. 소스 파일은 언제나 깔끔하게 정리하라. 잡동사니를 업애라!.

 

---

 

 - G13: 인위적 결합

 

서로 무관한 개념을 인위적으로 결합하지 않는다. 예로 일반적인 enum은 특정 클래스에 속할 이유가 없다.  함수, 상수, 변수를 선언할 때는 시간을 들여 올바른 위치를 고민한다 그저 당장 편한 곳에 선언하고 내버려 두면 안 된다.

 

---

 

 - G14: 기능 욕심

 

 클래스 메서드는 자기 클래스의 변수와 함수에 관심을 가져야지 다른 클래스의 변수와 함수에 관심을 가져서는 안 된다. 메서드가 다른 객체의 참조자와 변경자를 사용해 그 객체 내용을 조작한다면 메서드가 그 객체 클래스의 범위를 욕심내는 탓이다. 본인의 클래스만 신경 쓰고 조작하자.

 

---

 

 - G15: 선택자 인수

 

 함수의 false 인수만큼 밉살스러운 코드도 없다. boolean 뿐만 아니다. enum, int 등 함수 동작을 제어하려는 인수는 하나 같이 바람직하지 않다. 일반적으로 인수를 넘겨 동작을 선택하는 대신 새로운 함수를 만드는 편이 좋다.

 

---

 

 - G16: 모호한 의도

 

코드에 의도를 최대한 분명히 밝힌다. 표기법, 매직 번호 등은 저자의 의도를 흐린다. 의도를 분명히 하도록 최대한 시간을 투자한다.

 

---

 

 - G17: 잘못 지운 책임

 

  소프트웨어 개발자가 내리는 가장 중요한 결정 중 하나가 코드의 배치이다. 이 메서드는 어떤 클래스에 들어가야 하는가? 

여기서도 '최소 놀람의 원칙'을 적용한다. 코드는 독자가 자연스럽게 기대할 위치에 배치한다.

 

---

 

 - G18: 부적절한 static 함수

 

 Math.max(double a, double b)는 좋은 static 메서드다. 특정 인스턴스와 관련된 기능이 아니다. 따라서 재정의할 가능성이 매우 적다. 특정 인스턴스와 관련된 기능일 경우 인스턴스 함수로 정의한다. 조금이라도 의심스럽다면. 반드시 static 함수로 정의해야겠다면 재정의할 가능성은 없는지 꼼꼼히 따져본다.

 

---

 

 - G19: 서술적 변수

 

 프로그램 가독성을 높이는 가장 효과적인 방법 중 하나가 계산을 여러 단계로 나누고 중간 값으로 서술적인 변수 이름을 사용하는 방법이다.

 

Matcher match = headerPattern,matcher(line);
if(match.find()){
    String key = match.group(1);
    String value = match.group(2);
    headers.put(key.toLowerCase(), value);
}

 서술적인 변수 이름을 사용한 덕에 첫 번째로 일치하는 그룹이 키(Key)이고 두 번째로 일치하는 그룹이 값(value)이라는 사실이 명확히 드러난다.

 

 서술적인 변수 이름은 많이 써도 괜찮다. 일반적으로 많을수록 더 좋다. 계산을 몇 단계로 나누고 중간값에 좋은 변수 이름만 붙여도 해독하기 어렵던 모듈이 순식간에 읽기 쉬운 모듈로 탈바꿈한다.

 

---

 

 

 - G20: 이름과 기능이 일치하는 함수

 

Date newDate = date.add(5) // (X) date 에 무엇을 더하는 건가? (일? 월?)

Date newDate = date.addDay(5) // (O) 무엇을 더하는지 명확히 한다.

 

 이름만으로 분명하지 않아서 구현을 살피거나 문서를 뒤적여야 한다면 더 좋은 이름으로 바꾸거나 아니면 더 좋은 이름을 붙이기 쉽도록 기능을 정리해야 한다.

---

 

 - G21: 알고리즘을 이해하라.

 

 어찌어찌하여 돌아가는 코드를 두고 구현이 끝났다고 선언하기 전에 함수가 돌아가는 방식을 확실히 이해하는지 확인하라.

테스트 케이스를 모두 통과한다는 사실만으로 부족하다. 작성자가 알고리즘이 올바르다는 사실을 알아야 한다.

 

---

 

 - G22: 논리적 의존성은 물리적으로 드러내라

 

 한 모듈이 다른 모듈에 의존한다면 물리적인 의존성도 있어야 한다. 논리적인 의존성만으로는 부족하다. 의존하는 모듈이 상대 모듈에 대해 뭔가를 가정하면 (즉, 논리적으로 의존하면)  안 된다. 의존하는 모든 정보를 명시적으로 요청하는 편이 좋다.

 

---

 

 - G23: If/Else 혹은 Switch/Case 문보다 다형성을 사용하라

 

 3장에서는 새 함수를 추가할 확률이 높은 코드에서는 switch 문이 더 적합하다 주장했다.

이유로는 첫째, 당장의 손쉬운 선택이기 때문이다. 그러므로 switch를 선택하기 전에 다형성을 먼저 고려하라

 둘째, 유형보다 함수가 더 쉽게 변하는 경우는 극히 드물다. 그러므로 모든 switch문을 의심해야 한다.

 

 저자는 'switch문 하나' 규칙을 따른다. 즉, 선택 유형 하나에는 switch문을 한 번만 사용한다. 같은 선택을 수행하는 다른 코드에서는 다형성 객체를 생성해 switch 문을 대신한다.

 

---

 

 - G24: 표준 표기법을 따르라

 

 팀은 업계 표준에 기반한 구현 표준을 따라야 한다. 표준을 설명하는 문서는 코드 자체로 충분해야 하며 별도 문서를 만들 필요는 없어야 한다. 팀이 정한 표준은 팀원들 모두가 따라야 한다. 실제 괄호를 넣는 위치는 중요하지 않다. 모두가 동의한 위치에 넣는다는 사실이 중요하다. 이 사실을 이해할 정도로 팀원들이 성숙해야 한다.

---

 

 - G25: 매직 숫자는 명명된 상수로 교체하라

 

  일반적으로 코드에서 숫자를 사용하지 마라. 예로 86,00이라는 숫자는 SECOND_PER_DAY라는 상수 뒤로 숨긴다.

'매직 숫자'라는 용어는 단지 숫자만 의미하지 않는다. 의미가 분명하지 않는 토큰을 모두 가리킨다. 아래의 코드에서는 7777 만이 아니라 John Doe 또한 매직 숫자이다.

 

assertEquals(7777, Employee.find("John Doe").employeeNumber());

---

 

 - G26: 정확하라

 

 - 검색 결과 중 첫 번째 결과만 유일한 결과로 간주하는 행동은 순진하다.

 - 부동 소수점으로 통화를 표현하는 행동은 거의 범죄에 가깝다.

 - 갱신할 가능성이 희박하다고 잠금과 트랜잭션 관리를 건너뛰는 행동은 게으름이다.

 - List로 선언할 변수를 ArrayList로 선언하는 행동은 지나친 제약이다.

 - 모든 변수를 protected로 선언한 코드는 무절제하다.

 

 코드에서 뭔가를 결정할 때는 정확히 결정한다. 결정을 내리는 이유와 예외를 처리할 방법을 분명히 알아야 한다.

 

 - 호출하는 함수가 Null을 반환할지도 모른다면 반드시 Null을 점검한다.

 - 조회 결과가 하나뿐이라고 짐작한다면 하나인지 확실히 확인한다.

 - 통화를 다뤄야 한담녀 정수를 사용하고 반올림을 올바로 처리한다.

 - 병행(Concurrent) 특성으로 인해 동시에 갱신할 가능성이 있다면 적절한 잠금 메커니즘을 구현한다.

 

 코드에서 모호성과 부정확은 의견차나 게으름의 결과이다. 어느 쪽이든 제거해야 마땅하다.

---

 

 - G27: 관례보다 구조를 사용하라

 

 설계 결정을 강제할 때는 규칙보다 관례를 사용한다. 명명 관례도 좋지만 구조 자체로 강제하면 더 좋다.

예로 Enum변수가 잘 구성된 switch/case 문보다 추상 메서드가 있는 기초 클래스가 더 좋다. switch/case 문을 매번 똑같이 구현하게 강제하기는 어렵지만, 파생 클래스는 추상 메서드를 모두 구현하지 않으면 안 되기 때문이다.

 

---

 

 - G28: 조건을 캡슐화하라

 

 부울 논리는 이해하기 어렵다 조건의 의도를 분명히 밝히는 함수로 표현하라.

 

---

 

 - G29: 부정 조건은 피하라

 

 부정 조건은 긍정 조건보다 이해하기 어렵다. 가능하면 긍정 조건으로 표현한다.

 

---

 

 - G30:  함수는 한 가지만 해야 한다.

 

 함수는 반드시 한 가지 임무만 수행하도록 한다.

 

---

 

 - G31: 숨겨진 시각적인 결합

 

 때로는 시간적인 결합이 필요하다. 하지만 시간적인 결합을 숨겨서는 안 된다. 함수 인수를 적절히 배치해 함수가 호출되는 순서를 명백히 드러낸다.

 

아래 코드는 주석과 같이 1,2,3 순서로 실행되어야 한다. 하지만 2 번째가 먼저 실행이 가능하도록 설계되어 있다.

public class MoogDiver {
    Gradient gradient;
    List<Spline> splines;
    
    public void dive(String reason){
        saturateGradient(); //1
        reticulateSplines(); //2 
        diveForMoog(reason) //3
    }
}

위의 코드를 아래와 같이 변경하면 일종의 연결 소자를 생성해 시각적인 결합을 노출한다.

각 함수가 내놓은 결과는 다음 함수에 필요하다. 그러므로 순서를 바꿔 호출할 수가 없다.

public void dive(String reason){
    Gradient gradient = saturateGradient();
    List<Spline> splines = reticulateSplines(gradient);
    diveForMoog(splines, reason)
}

 

 함수가 복잡해질 수 있다. 하지만 의도적으로 추가한 구문적인 복잡성이 원래 있던 시간적인 복잡성을 드러낸 셈이다.

 

---

  

  - G32: 일관성을 유지하라

 

 코드 구조를 잡을 때는 이유를 고민하라. 그리고 그 이유를 코드 구조로 명백히 표현하라. 구조에 일관성이 없어 보인다면 남들이 맘대로 바꿔도 괜찮다고 생각한다.

 

---

 

 - G33: 경계 조건을 캡슐화하라

 

 경계 조건은 한 곳에서 별도로 처리한다. 

 

// X
foo(level + 1);

// O
int nextlevel = level + 1;
foo(nextlevel);

---

 

 - G34: 함수는 추상화 수준을 한 단계만 내려가야 한다.

 

 함수 내 모든 문장은 추상화 수준이 동일해야 한다. 그리고 그 추상화 수준은 함수 이름이 의미하는 작업보다 한 단계만 낮아야 한다.

추상화 수준 분리는 리펙터링을 수행하는 가장 중요한 이유 중 하나이며 제대로 하기에 가장 어려운 작업 중 하나이다.

 함수에서 추상화 수준을 분리하면 앞서 드러내지 않았던 새로운 추상화 수준이 드러나는 경우가 빈번하다. 

 

---

 

 - G35: 설정 정보는 최상위 단계에 둬라

 

 추상화 최상위 단계에 둬야 할 기본값 상수나 설정 관련 상수를 저 차원 함수에 숨겨서는 안 된다. 대신 고차원 함수에서 저 차원 함수를 호출할 때 인수로 넘긴다.

 설정 관련 상수는 최상위 단계에 둔다. 그래야 변경하기도 쉽다. 설정 관련 변수는 나머지 코드에 인수로 넘긴다. 저차원 함수에 상수 값을 정의하면 안 된다.

 

 

---

 - G36: 추이적 탐색을 피하라.

 

 일반적으로 한 모듈은 주변 모듈을 모를수록 좋다. 예로 A가 B를 사용하고 B가 C를 사용하더라도 A가 C를 알아야 할 필요는 없다.

이를 디미터 법칙이라 한다. 실용주의 프로그래머들은 '부끄럼 타는 코드 작성(Writing Shy Code')이라고도 한다. 핵심은 자신이 직접 사용하는 모듈만 알아야 한다.

 내가 사용하는 모듈이 내게 필요한 서비스를 모두 제공해야 한다. 원하는 메서드를 찾느라 객체 그래프를 따라 시스템을 탐색할 필요가 없어야 한다.

 

---

 

.자바

 

 - J1: 긴 import 목록을 피하고 와일드카드를 사용하라

 

 패키지에서 클래스를 둘 이상 사용한다면 와일드카드를 사용해 패키지 전체를 가져오라.

 

명시적인 import 문은 강한 의존성을 생성하지만 와일드카드는 그렇지 않다. 명시적으로 클래스를 import 하면 그 클래스는 반드시 존재해야 하지만 와일드카드로 패키지를 지정하면 클래스가 반드시 존재할 필요는 없다. import 문은 패키지를 단순히 검색 경로에 추가하므로 진정한 의존성이 생기지 않느다. 그러므로 모듈 간 결합성이 낮아진다. 레거시 코드라도 와일드카드 import 문을 사용하는 편이 좋다.

 

---

 

 - J2: 상수는 상속하지 않는다.

 

 상수를 상속 계층 맨 위에 숨겨놓는 것은 끔찍한 관행이다. 언어의 범위 규칙을 속이는 행위다. 대신 static import를 사용해라

---

 - J3: 상수 대 Enum

 

  int 보다 훨씬 더 유연하고 서술적인 강력한 도구인 Enum을 활용해라.

 

---

 

.이름

 

 - N1: 서술적인 이름을 사용하라

 

 소프트 웨어의 가독성의 90%는 이름이 결정한다. 이름은 성급하게 정하지 않는다. 서술적인 이름을 신중하게 고른다. 소프트웨어가 진화하면 의미도 변하므로 선택한 이름이 적합한지 자주 되돌아본다.

 

---

 

 - N2: 적절한 추상화 수준에서 이름을 선택하라

 

 구현을 드러내는 이름은 피해라. 작업 대상 클래스나 함수가 위치하는 추상화 수준을 반영하는 이름을 선택해라.

 

---

 

 -  N3: 가능하다면 표준 명명법을 사용하라

 

 기존 명명법을 사용하는 이름은 이해하기 더 쉽다. 예로 Decorator 패턴을 활용한다면 클래스 이름에 Decorator라는 단어를 사용한다.

패턴은 한 가지 표준에 불고하다. 예로 자바에서 객체를 문자열로 반환하는 함수는 toString이라는 이름을 많이 쓴다. 이런 이름은 관례를 따르는 편이 좋다.

 흔히 팀마다 특정 프로젝트에 적용할 표준을 나름대로 고안한다. 에릭 에반스는 이를 프로젝트의 유비쿼터스 언어라 부른다. 코드는 이 언어에 속하는 용어를 열심히 써야 한다. 프로젝트에 유효한 의미가 담긴 이름을 많이 사용할수록 독자가 코드를 이해하기 쉬워진다.

 

---

 

 - N4: 명확한 이름

 

 함수나 변수의 목적을 명확히 밝히는 이름을 선택한다. 함수가 하는 일을 분명히 파악할 수 있도록 한다.

 

---

 

 - N5: 긴 범위는 긴 이름을 사용하라

 

 이름 길이는 범위 길이에 비례해야 한다. 범위가 작으면 아주 짧은 이름을 사용해도 괜찮다. 하지만 범위가 길어지면 긴 이름을 사용한다.

범위가 5줄 안팎이라면 i나 j 같은 변수 이름도 괜찮다. 짧은 범위에서 긴 이름을 사용할 경우 오히려 헷갈릴 수 있다. 반면 이름이 짧은 변수나 함수는 범위가 길어지면 의미를 잃는다. 그러므로 이름 범위가 길수록 이름을 정확하고 길게 짓는다.

 

---

 

 - N6: 인코딩을 피하라

 

 이름에 유형 정보나 범위 정보를 넣어서는 안 된다. m_, s_와 같은 접두어는 불필요하다.  헝가리안 표기법의 오염에서 이름을 보호하라.

 

---

 

 - N7: 이름으로 부수 효과를 설명하라

 

 함수, 변수, 클래스가 하는 일을 모두 기술하는 이름을 사용한다. 이름에 부수 효과를 숨기지 않는다. 

 

---

  . 테스트

 

 - T1: 불충분한 테스트

 

 테스트 케이스는 잠재적으로 깨질 만한 부분을 모두 테스트해야 한다. 테스트 케이스가 확인하지 않는 조건이나 검증하지 않는 계산이 있다면 그 테스트는 불완전하다.

 

---

 

 - T2: 커버리지 도구를 사용하라

 

커버리지 도구는 테스트가 빠뜨리는 공백을 알려준다. 

 

---

 - T3: 사소한 테스트를 건너뛰지 마라

 

 사소한 테스트는 짜기 쉽다. 사소한 테스트가 제공하는 문서적 가치는 구현에 드는 비용을 넘어선다.

 

---

 

 - T4: 무시한 테스트는 모호함을 뜻한다.

 

 불문 명한 요구사항으로 프로그램 돌아가는 방식을 활용하기 어려울 때는 테스트 케이스를 주석으로 처리하거나 테스트 케이스에 @Ignore를 붙여 표현한다. 선택 기준은 모호함이 존재하는 테스트 케이스가 컴파일이 가능한지 불가능한지에 달려있다.

 

---

 

 - T5: 경계 조건을 테스트하라

 

 경계 조건은 각별히 신경 써서 테스트한다. 알고리즘의 중앙 조건은 올바로 짜 놓고 경계 조건에서 실수하는 경우가 흔하다.

 

---

 

 - T6: 버그 주변은 철저히 테스트하라

 

 버그는 서로 모이는 경향이 있다. 한 함수에서 버그를 발견했다면 그 함수를 철저히 테스트하는 편히 좋다. 다른 버그도 발견될 가능성이 높다.

 

---

 

 - T7: 실패 패턴을 살펴라

 

 때로는 테스트 케이스가 실패하는 패턴으로 문제를 진단할 수 있다. 테스트 케이스를 최대한 꼼꼼히 짜라는 이유도 여기 있다. 합리적인 순서로 정렬된 꼼꼼함 테스트 케이스는 실패 패턴을 드러낸다.

 

---

 

 - T8:  테스트 커버리지 패턴을 살펴라

 

 통과하는 테스트가 실행하거나 실행하지 않는 코드를 살펴보면 실패하는 테스트 케이스의 실패 원인이 드러난다.

 

---

 

 - T9: 테스트는 빨라야 한다.

 

 느린 테스트 케이스는 실행하지 않게 된다. 최대한 빨리 돌아갈 수 있게 한다.

 

---

 .결론

 

 이 장에서 소개한 휴리스틱과 냄새 목록이 완전하다 할 수 없다. 하지만 완전한 목록이 목표가 아니다. 가치 체계를 피력할 뿐이다. 일군의 규칙만 따른다고 깨끗한 코드가 얻어지지 않는다. 휴리스틱 목록을 익힌다고 소프트웨어 장인이 되지는 못한다. 전문가 정신과 장인 정신은 가치에서 나온다. 그 가치에 기반한 규율과 절제가 필요하다.

---

 

📝 느낀점.

 - 마지막 장이여서 그런지 전반적으로 중요한 내용의 핵심들을 간략히 설명을 해주어 정리가 되는 장이였다.
 - 목록을 읽힌다 하여 장인이 되지 못한다 하였지만. 아직 목록도 제대로 적용을 해본 경험이 없어. 장인을 논하기 전에 먼저 경험을 해보야겠다...