1. 네이밍 컨벤션, 이유를 알고 쓰자
이름 짓기는 창조가 아니라 조합이다.
자바 네이밍 컨벤션을 철저히 준수한다
네이밍은 보통 16글자, 3단어를 조합한다.
- 클래스 : UperCamelCase (3.18)
- 함수 & 변수 : lowerCamelCase (3.36)
- 상수 : UPPER_DELIMITER_CASE (2.57)
코드의 네이밍 컨벤션은 영어 표기법을 상속받았다.
다음은 대문자 표기 규칙 중 일부이다.
- 고유명사 첫 글자
I love Korea- 이름 앞 직함의 첫 글자
Docter Mr.Micheal- 책, 신문, 잡지, 음악, 영화 등의 제목에 나오는 첫 글자와 마지막 단어의 첫 글자와 관사
Marvel's The Avengers- 출판물의 일부와 관련한 명사 다음에 숫자가 올 때
Section 2- 요일, 휴일, 달, 역사적 사건, 역사적 기간
World War 1- 천체의 첫 이름
It is the Mars
카멜 표기법으로 함수, 변수의 이름 짓기
카멜 표기법 : 첫 단어를 빼고 나머지 단어의 첫 번째 글자 만 대문자로 작성한다. 주로 함수나 변수에 사용
영어 표기 원칙의 기본은 명사가 아닌 경우 첫 글자를 소문자로 시작한다. 따라서 함수와 변수는 모두 첫 단어의 첫 글자를 소문자로 작성
int totalCount=0;
void orderCoffee();
상수는 모두 대문자로 작성한다
패키지와 모듈은 모두 소문자로 쓴다.
kr.co.wikibook.android.develperwriting
import developerwriting
BEM 표기법
대상의 요소나 부분 : __
대상이나 요소의 상태나 속성 : --
.form{}
.form__button {}
.form__button--disabled {}
2. 변수 이름을 잘 짓는 법
- i는 변수 이름이지만 d는 아니다
(아무런 의미 없는 글자를 변수로 쓰는 것 지양할 것) - 검색 잘 되는 이름 사용할 것
- 복수형 일 때 s 붙이는 여부는 추후 통일해서 결정
- 약어-> 보편성 기준으로 정할 것
- 중요한 단어를 앞에 쓴다
총 ~ 한 수를 구할 때 total로 검색을 시작하는 경우가 많다
나쁜 예
int totalVisitor
int totalBuyer좋은 예
int visitorTotal
int BuyerTotal
3. 좋은 이름의 기준, SMART
좋은 이름이 가진 다섯 가지 특징은 다음과 같다
- easy to Search
- easy to MIX
- easy to Agree
- easy to Remember
- easy to Type
1. easy to Serch
한단계 상위 범주의 이름을 태그처럼 덧붙이기.
ERROR_SERVER_TIMEOUT
ERROR_NO_RESULT
ERROR_BAD_REQUEST
userBuyer
userPayer
userRegiester
스타일 이름을 지을 때 개발 언어의 문법과 조합해 이름을 짓는 것도 하나의 방법이다.
2. easy to Agree
누가 보더라도 그렇게 짓는 것이 더 낫다고 동의하는 이름을 짓자
3. easy to Remember
개발자만 보는 개발문서라면 보편적으로 쓰는 이름은 그대로 써도 무방하다. 굳이 바꿀 필요 없다. 널리 알려진 용어는 그냥 쓰는 것이 효율적!
4. easy to Type
자주 사용되거나 중요한 이름이라면 입력하기 쉬운지, 오타를 낼 가능성이 적은지 고려해야한다.
ex. 잘 틀리는 예
- 연속된 철자(success)
- 묵음(lambda)
- ie/ei
- sion
- uous/ous/us(continuous, fabulous, genius)
4. 좋은 코드에는 주석이 없다?
이름을 잘 지으면 주석을 줄일 수 있다!
-> 처음부터 주석없이 코딩하는 연습을 할 것
"
OK":true //요청에 대한 성공,실패 여부 구분
"isRequestSuccess":true
5. 다른 개발자를 배려하는 주석 쓰기
- 주석은 반복될 수 있다. 특정 함수를 검색해서 보는 경우도 있기 때문에 필요하다면 같은 주석이라도 반복해서 작성해야한다.
- 주석도 코드라고 생각할 것! 코드 리뷰를 하면서 주석 리뷰도 꼼꼼히 해야한다.
