의도를 분명히 하라
이름의 길이
- 의미가 분명한 경우 이름이 짧을수록 좋다
- 이름 길이는 범위 크기에 비례한다. 아주 작은 블럭의 로컬 변수는 짧게 지어도 괜찮다
i : for문 안에서 사용하는 인덱스 변수
- 축약을 피해라
product -> prd, project -> prj
이름에 넣지 말아야 할 것
- 자료형, 타입
addList, sumList, iEmployeeNumber, sEmployeeName
- info / data 같이 의미 없는 단어
이름을 정할 때 유의해야 할 것
- 흡사한 이름을 사용하지 말라
- 유사한 개념은 유사한 표기법을 사용하라
add, append, ...
- 검색하기 쉬운 이름을 사용하라
인터페이스와 구현 클래스가 있는 경우 인터페이스의 이름을 원형으로, 추가 정보는 구현 클래스의 이름에 붙인다
IShapeFactory - ShapeFactory (X) ShapeFactory - ShapeFactoryImpl (O)
생성자를 중복정의 할 때에는 정적 팩토리 메서드를 사용한다
Complex fulcrumPoint = Complex.fromRealNumber(23.0) (O) Complex fulcrumpoint = new Complex(23.0) (X)
반응형
'reviews > Clean Code' 카테고리의 다른 글
06. 객체와 자료 구조 (0) | 2021.01.21 |
---|---|
05. 형식 맞추기 (0) | 2021.01.19 |
04. 주석 (0) | 2021.01.19 |
03. 함수 (0) | 2021.01.18 |
01. 깨끗한 코드 (0) | 2021.01.18 |