클린 코드 독서일지 - Day 42

자바

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

ex) import package.*;

긴 import 목록은 읽기에 부담스러우며, 명시적인 import문은 강한 의존성을 생성함

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

상수는 상속 대신 static import를 사용한다.

J3: 상수 대 Enum

public static final int보다 enum을 사용하라.

enum은 이름이 부여된 열거체로, 메서드와 필드도 사용할 수 있는 훨씬 유연하고 서술적인 도구이다.

이름

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

소프트웨어 가독성의 90%는 이름이 결정한다.
서술적인 이름을 신중하게 골라야 함

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

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

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

기존 명명법을 사용하면 이해하기 더 쉽다.
ex) DECORATOR 패턴을 활용한 클래스 이름에 Decorator 단어를 사용하기
프로젝트의 표준 명명법을 사용할수록 독자가 코드를 이해하기 쉬워진다.

N4: 명확한 이름

함수나 변수의 목적을 명확히 밝히는 이름을 선택한다.
길더라도 서술적인 이름을 사용하라.

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

이름 길이는 범위 길이에 비례해야 한다.
범위가 작으면 아주 짧은 이름을 사용해도 괜찮지만(ex: 5줄 이내의 코드 블럭 속 i나 j 변수명 등) 범위가 길어지면 긴 이름을 사용한다.

N6: 인코딩을 피하라

이름에 유형 정보나 범위 정보를 넣어서는 안 된다.
오늘날 개발 환경에서는 이름을 조작하지 않고도 모든 정보를 제공하므로, m_이나 f와 같은 접두어가 불필요하다.