본문 바로가기

플밍 is 뭔들/Clean Code

1-6. 이름을 잘 짓는 간단한 규칙 (인코딩을 피하자)

자바 프로그래머는 변수 이름에 타입을 인코딩할 필요가 없다.
(변수 이름에 타입 작성 X, 헝가리식 표기법이 오히려 방해가 됨.)


이런식으로 이름에 타입을 인코딩하면 변수, 함수, 클래스 이름이나 타입을 바꾸기가 어려워지며, 읽기도 어려워진다. 
또한 독자를 오도할 가능성도 커진다.

int PhoneNumber; 
String phoneString;

//이렇게 변수 이름에 타입을 인코딩하면 나중에 변수 타입이 바뀌어도 이름이 바뀌지 않는 경우 발생

 

멤버 변수(메소드 밖에서 선언된 변수)의 m_이라는 접두어를 붙일 필요도 없다. 
클래스와 함수는 접두어가 필요 없을 정도로 작아야 마땅하다.
또한 멤버 변수를 다른 색상으로 표시하거나 눈에 띄게 보여주는 IDE(프로그래머가 소프트웨어 코드를 효율적으로 개발하도록 돕는 소프트웨어 애플리케이션)를 사용해야 마땅하다.

//안좋은 예시
public class Part{
	private String m_dsc //설명 문자열
		
	void setName(String name){
		m_dsc = name;
	}
}

//좋은 예시
public class Part{
	private String description;
		
	void setDescription(String description){
		this.description = description;
	}
}