본문 바로가기
프로그래밍 놀이터/디자인 패턴, 리펙토링

[Effective Java] 보편화된 작명 규칙을 따르자.

by 돼지왕왕돼지 2017. 2. 17.
반응형

 [Effective Java] 보편화된 작명 규칙을 따르자.


aslist, astype, boolean, e, Effective JAVA, Get, getinstance, gettime, gettype, hashcode, intValue, K, map, newinstance, newtype, of, Return, Size, static, T, T1, T2, T3, toarray, toString, totype, typevalue, U, v, valueOf, X, [Effective Java] 보편화된 작명 규칙을 따르자., 객체, 객체타입, 관례, 기본형 값, 단일 문자, 동사, 두문자, 매개변수, 메소드, 명사, 명사구, 문법 작명 규칙, 보편화된 작명 규칙, 뷰, 사용법, 약어, 인자, 작명 규칙, 정립, 패키지, 팩토리 메소드, 표준 작명 규칙, 호출


-
패키지 이름은 짧게 하되, 일반적으로 9자 이내의 문자가 좋다.
awt와 같이 복합 단어의 첫 자를 딴 두문자나, util 과 같은 약어를 사용해도 좋다.


-
타입 매개변수의 이름은 통상적으로 단일 문자이며, 대부분 다음 다섯 개 중 하나이다.

임의 타입은 T, 컬렉션 요소 타입은 E, Map 의 키와 값은 K, V, 예외는 X
임의 타입의 순차는 T에 이어 U, V 또는 T1, T2, T3 등과 같이 하기도 한다.


-
boolean 이 아닌 속성을 반환하는 메소드의 이름은 명사, 명사구, 또는 동사인 get 으로 시작하는 동사구로 구성한다.
size, hashCode, getTime 등이 그 예이다.
이런 return 값이 있는 메소드들은 get 으로 시작해야 한다고 주장하는 사람이 많으나,
가독성 측면에서 별로 근거가 없는 주장이다.


-
객체타입을 변환하는 메소드의 이름은
toString, toArray 처럼 toType 의 이름을 갖는다.


-
인자로 받은 객체와 다른 타입의 뷰를 반환하는 메소드 이름은
asList 처럼 asType 으로 짓는다.


-
메소드가 호출된 객체와 같은 값을 갖는 기본형 값을 반환하는 메소드 이름은 intValue 처럼 typeValue 라고 짓는다.


-
static 팩토리 메소드의 이름으로 자주 사용하는 것은
valueOf, of, getInstance, newInstance, getType, newType 등이 있다.



Summary


제 2의 천성처럼 표준 작명 규칙을 내 것으로 만들고 사용법을 배우자.
글자 작명 규칙은 간단해서 전반적으로 분명하다.
그러나 문법 작명 규칙은 더 복잡하고 정립이 덜 되어 있다.
"오랫동안 지켜 온 관례가 이와 다르다면, 이 작명 규칙을 무조건 따르지 않아도 된다." 라는 상식은 동원하자





반응형

댓글0