Skip to content

Commit 5d3e118

Browse files
committed
[아이템 68] 일반적으로 통용되는 규칙을 따르라
1 parent 7a0df8b commit 5d3e118

File tree

1 file changed

+120
-0
lines changed

1 file changed

+120
-0
lines changed

chapter09/item68/README.md

+120
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# 아이템68. 일반적으로 통용되는 규칙을 따르라
2+
3+
# 책정리
4+
5+
```java
6+
아이템17
7+
```
8+
9+
# 자바의 명명 규칙
10+
11+
# 철자 규책
12+
13+
## **패키지, 클래스, 인터페이스, 메서드, 필드, 타입 변수**
14+
15+
### 패키지와 모듈 이름
16+
17+
각 요소를 점(.)으로 구분하여 계층적으로 짓는다. 요소들은 모두 소문자 알파벳 혹은 (드물게)숫자로 이뤄진다.
18+
19+
조직 바깥에서도 사용될 패키지라면 조직의 인터넷 도메인 이름을 역순으로 사용한다.
20+
21+
예외적으로 표준 라이브러리와 선택적 패키지들은 각각 java와 javax로 시작한다. 도메인 이름을 패키지 이름의 접두어로 변환하는 자세한 규칙은 자바 언어 명세에 적혀 있다.
22+
23+
패키지 이름의 나머지는 해당 패키지를 설명하는 하나 이상의 요소로 이뤄진다. 각 요소는 일반적으로 8자 이하의 짧은 단어로 한다. utilities보다는 util처럼 의미가 통하는 약어를 사용한다.
24+
25+
여러 언어로 구성된 이름이라면 awt처럼 각 단어의 첫 글자만 따서 써도 좋다.
26+
27+
### 클래스와 인터페이스(열거 타입, 애너테이션 포함)
28+
29+
클래스와 인터페이스의 이름은 하나 이상의 단어로 이뤄지며, 각 단어는 대문자로 시작한다.(List, FutherTask)
30+
31+
여러 단어의 첫 글자만 딴 약자나 max, min처럼 널리 통용되는 줄임말을 제외하고는 단어를 줄여 쓰지 않도록 한다. 약자의 경우 첫 글자만 대문자로 할지 전체를 대문자로 할지는 논란이 있다. 이건 각 컨벤션에 따를 것.
32+
33+
### 메서드와 필드 이름
34+
35+
첫 글자를 소문자로 쓴다는 점만 빼면 클래스 명명 규칙과 같다(remove, ensureCapacity). 첫 단어가 약자라면 단어 전체가 소문자여야 한다.
36+
37+
단 '상수 필드'는 예외다. 상수 필드를 구성하는 단어는 모두 대문자로 쓰며 단어 사이는 밑줄로 구분한다.
38+
39+
예시) VALUES, NEGATIVE_INFINITY
40+
41+
상수 필드는 값이 불변인 static final 필드를 말한다. static final 필드의 타입이 기본 타입이나 불변 참조 타입 이라면 상수 필드에 해당한다. static final 필드이면서 가리키는 객체가 불변이라면 비록 그 타입은 가변이더라도 상수 필드다.
42+
43+
이름에 밑줄을 사용하는 요소로는 상수 필드가 유일하다.
44+
45+
### 지역변수
46+
47+
다른 멤버와 비슷한 명명 규칙이 적용된다. 단, 약어를 써도 좋다. 약어를 써도 그 변수가 사용되는 문맥에서 의미를 쉽게 유추할 수 있기 때문이다.(i, denom, houseNum 등) 입력 매개변수도 지역변수의 하나다.
48+
49+
### 타입 매개변수
50+
51+
보통 한 문자로 표현한다. 대부분은 다음의 다섯 가지 중 하나다.
52+
53+
- T: 임의의 타입
54+
- E: 컬렉션 원소의 타입
55+
- K, V: 맵의 키와 값
56+
- X: 예외
57+
- R: 메서드의 반환 타입
58+
59+
그 외에 임의 타입의 시퀸스에는 T, U, V or T1, T2, T3를 사용한다.
60+
61+
# 문법 규칙
62+
63+
## 클래스
64+
65+
### 객체를 생성할 수 있는 클래스
66+
67+
보통 단수 명사나 명사구를 사용한다(Thread, PriorityQueue, ChessPiece...)
68+
69+
### 객체를 생성할 수 없는 클래스
70+
71+
보통 복수형 명사(Collectors, Collections 등)
72+
73+
### 인터페이스
74+
75+
- 클래스와 똑같이 짓거나(Collection, Comparator 등)
76+
- able혹은 ible로 끝나는 형용사로 짓는다.(Runnable, Iterable, Accessible)
77+
78+
### 애너테이션
79+
80+
다양하게 활용. 명사, 동사, 전치사, 형용사 두루 쓰인다.
81+
82+
## 메서드
83+
84+
### boolean이 아니거나 인스턴스의 속성을 반환하는 메서드
85+
86+
보통 명사, 명사구, 혹은 get으로 시작하는 동사구로 짓는다.(size, hashCode, getTime 등)
87+
88+
# 특별한 메서드 이름
89+
90+
객체의 타입을 바꿔서, 다른 타입의 또 다른 객체를 반환하는 인스턴스 메서드의 이름은 보통 toType 형태로 짓는다. (toString, toArray 등).
91+
92+
객체의 내용을 다른 뷰로 보여주는 메서드의 이름은 asType 형태로 짓는다.(asList)
93+
94+
객체의 값을 기본 타입 값으로 반환하는 메서드의 이름은 보통 typeValue 형태로 짓는다.(intValue)
95+
96+
마지막으로 정적 팩터리의 이름은 다양하지만 from, of, valueOf, instance, getInstance, newInstance, getType, newType을 흔히 사용한다.
97+
98+
- from : 하나의 매개 변수를 받아서 객체를 생성한다.
99+
- of : 두개 이상의 매개 변수를 받아서 객체를 생성한다.
100+
- getInstance : 인스턴스를 생성한다. 같은 인스턴스임을 보장하지는 않는다.
101+
- newInstance, create : 매번 새로운 인스턴스를 생성함을 보장한다.
102+
103+
## 필드
104+
105+
덜 명확하고 덜 중요하다. API 설계를 잘했다면 필드가 직접 노출될 일이 거의 없기 때문이다. boolean 타입의 필드 이름은 보통 boolean 접근자 메서드에서 앞 단어를 뺀 형태다.
106+
107+
108+
109+
## 자바 컨벤션
110+
111+
- 캠퍼스 핵데이 Java 코딩 컨벤션
112+
113+
https://naver.github.io/hackday-conventions-java/#class-noun
114+
115+
- 구글 자바 스타일 가이드
116+
117+
https://google.github.io/styleguide/javaguide.html#s5-naming
118+
119+
번역: [https://velog.io/@new_wisdom/JAVA-Google-Java-Style-Guide-%EB%B2%88%EC%97%AD](https://velog.io/@new_wisdom/JAVA-Google-Java-Style-Guide-번역)
120+

0 commit comments

Comments
 (0)