이름 짓기는 항상 필요하다. 이 장에서는 이름을 잘 짓는 팁을 공유한다.
북마크
의도를 분명히 밝혀라
- 의도가 분명한 이름이 정말로 중요하다.
- 좋은 이름은 시간을 절약한다.
- 따로 주석이 필요하다면 의도를 분명히 드러내지 못했다는 것이다.
- 변수명이 영어라면 한국어 의도를 100% 드러낼수 없다.
- 그래도 주석은 필요하다.
public List<Cell> getFlaggedCells() {
List<Cell> flaggeds = new ArrayList<Cell>();
for (Cell cell : gameBoard)
if (cell.isFlagged()) // cell[STATUS_VALUE] = FLAGGED 의 개선. 상수를 숨겼다.
flaggedCells.add(cell);
return flaggedCells();
}
그릇된 정보를 피하라
- 나름대로 널리 쓰이는 의미가 있는 단어를 다른 의미로 사용하면 안된다.
- 이름으로 그릇된 정보를 제공하는 예
- 어떤 계정을 그룹으로 묶을때, 실제 자료구조가 List 가 아니라면 List 라는 이름을 포함하지 않는다.
- 서로 흡사한 이름을 사용한다.
- 소문자 ㅣ 이나 대문자 O 변수
의미있게 구분하라
- 아무런 정보를 제공하지 못하는 이름
- 읽는 사람이 차이를 알도록 이름을 지어라
getActiveAccount();
getActiveAccounts();
getActiveAccountInfo();
발음하기 쉬운 이름을 사용하라
- 발음하기 어려운 형편없는 이름을 지양하라
- genymdhms (젠 야 무다 함즈? 젠 와이 엠 디 에이취 엠 에스?)
검색하기 쉬운 이름을 사용하라
- 예를 들어 숫자, e 로 만들면 검색결과가 너무 많아 원하는 것을 찾기 어려울 것이다.
인코딩을 피하라