항상 누가 봐도 쉽게 눈에 들어도록 최대한 간결하게 코드를 짜는 것을 목표로 하자고 다짐했다.
그런 의미에서 이 책 "읽기 좋은 코드가 좋은 코드다"는 제목에서부터 내가 지향하는 바를 아주 정확하게 저격한다.
분량도 적당하고 내용도 읽기 쉽게 적절한 예시 코드와 함께 제시되어 있어서 무척 맘에 들었다.
1. 이름에 정보 담아내기
- 변수, 함수 혹은 클래스 등의 이름을 결정할 때는 이름이 일종의 설명문이 된다고 생각하고 이름에 정보를 담아낼 수 있도록 해야 한다.
즉 구체적이고 명확하며 적절한 길이의 이름을 붙여준다.
- 생성자는 대문자로, 평범한 함수는 소문자로 표기하거나
jQuery의 결과를 저장하는 변수 앞에는 $를 붙이거나
클래스의 멤버 변수명 뒤에는 _를 붙여주는 등의 포맷팅 방식을 사용하여 이름만으로 구분하기 쉽도록 한다.
2. 미학적으로 다듬기
- '열'로 만들어서 줄을 맞추거나 문단으로 나눠주는 등 시각적으로 보기 편하게 정렬해주는 작업을 진행한다.
3. 주석을 잘 활용하기
- 코드에서 쉽게 유추하기 쉬운 내용은 주석으로 달지 않는다.
- 코드가 왜 이렇게 작성되었는지, 코드에 어떤 결함이 있는지 등을 남겨주는 것은 좋다.
- 자신이 코드를 처음 읽는 외부인이라고 가정하고 주석을 작성하자.
4. 읽기 쉬운 흐름제어 만들기
- 조건문에서 오른쪽에 고정적인 값(비교대상)을 기술한다.
예: if(length > 10), if(received < expected)
- if(NULL == obj) 와 같이 Null 비교 시 버그 발생을 막기 위한 표기는 최근에는 불필요하게 되었다.
- 부정보다 긍정을 선호한다.
예: if(!flag) 보다 if(flag)를 사용
- 간단한 것을 먼저 처리함으로써 같은 화면에 if와 else 구문을 나타낼 수 있도록 한다.
- 함수 중간에서 반환하면 중첩을 제거할 수 있다.
5. 거대한 표현을 잘게 쪼개기
- 방대한 코드는 의미 파악이 쉬운 여러 조각으로 분할한다.
6. 변수 살펴보기
- 불필요한 임시변수는 제거한다.
- 변수가 적용되는 범위를 최대한 좁힌다.
- 자바스크립트에서 변수 정의 시 키워드 var를 생략하면 해당 변수는 전역 변수로 모든 자바스크립트 파일과 <script> 블록에 접근 가능하므로 유의한다.
- 변수 여러 개를 동시에 선언할 때는 경우에 따라 각 정의를 실제 사용 직전 위치로 옮긴다.
- 값이 한번만 할당되는 변수를 선호한다.
7. 코드 재작성하기
- 한번에 하나의 작업만 수행하도록 코드를 구성한다.
