CH.2
이름을 명확히 짓자!
변수/함수의 이름들은 주석없이 아래 내용들을 알 수 있어야 한다.
- 존재 이유(역할)
- 수행 기능
- 사용 방법
나쁜 예시
int d; //경과 시간 올바른 예시
int elapsedTimeInDays;
int daysSinceCreation;
int daysSinscemodification;
...이름은 항상 명확하게 짓자!
자료구조 이름을 이름에 넣지 말자!
만약, 계좌 정보들을 가진 List가 있을 경우, accountList라고 짓곤 한다.
하지만, 자료구조 이름인 List를 빼고, account<u>s</u> 처럼 작명하자
연속된 숫자, 불용어는 피하자!
a1, a2, a3와 같은 연속된 숫자를 이용한 변수들은 아무런 정보도 제공하지 않는 의미없는 이름이다.
Info, data 와 같은 역할과 내용을 유추하기 힘든 불용어들은 피하자.
변수 명을 Variable / 테이블 명을 Table 이라고 짓지말자!
발음하기 쉬운 이름으로 작명하자
발음하기 쉬워야 코드리뷰, 토론 등을 할 때도 수월하다
명사와 동사로
클래스 이름 = 명사
함수 이름 = 동사
같은 개념에 대한 이름은 하나로 통일!
Fetch, retrieve, get, receive 등 비슷한 개념을 가진 단어 중 하나만 선택해 사용한다.
어느 함수에선 GetNum, 다른 함수에선 RecieveNum 등 비슷한 개념을 가진 단어를 이것저것 사용하면, 가독성도 떨어지고, 이후 검색으로 찾을 때도 힘들다.