클린코드 5장 형식맞추기

코드 형식 맞추기, 다른 말로 코딩 컨벤션이라 할 수 있다.

형식을 맞추는 목적은, 앞으로 기능이 계속 바뀌어도, 처음 잡아놓은 가독성과 스타일은, 유지보수 용이성과 확장성에 계속 영향을 미치기 때문이다.

 

1. 적절한 행 길이

세로 길이부터 적절히 유지하자.

평균 65줄, 보통 200줄, 500줄이 넘으면 읽기가 힘들다.

 

실제로 본인 업무 프로젝트의 소스코드중 4~5000줄 그 이상 10000줄까지 넘어가 파일을 열 때 오랜 로딩과, 수정 시의 압박을 느끼게 되는 쿼리 파일이 있다. 이런 짓은 하지말자..

 

2. 개념 단위는 빈 행으로 구분하자.

우리는 소스를 글을 읽듯이 위에서 아래로, 왼쪽에서 오른쪽으로 읽느다.

하나의 완결된 생각 사이에는 빈 행을 넣어 분리해야 마땅하다.

 

3. 세로 밀집도.

서로 밀접한 연관을 가진 함수끼리는 세로로 놓자.

서로 밀접한 연관을 가진 함수는 한 파일에 속해야 한다.

protected 변수를 피해야 하는 이유이다.

 

4. 변수 선언

변수는 사용하는 위치에 최대한 가까이 선언하자.

지역변수는 메소드 내부 최상단, 멤버변수는 클래스 최상단에 선언하자.

로직 중간에 새로운 변수를 만드는 것보다 상단에 몰아 선언하는게 더 읽기 편하다.

 

5. 종속 함수

한 함수가 다른 함수를 호출한다면 세로로 가까이 배치한다.

또한 호출하는 함수를 호출되는 함수보다 먼저 배치하자. 그러면 자연스럽게 읽힌다.

 

6. 가로형식 맞추기

한 행은 45자가 적당하다.

짧을수록 좋다.

세로로 스크롤하지 않도록 하자.

눈이 좋다고 폰트를 작게해서 화면에 채워 쓰지도 말자.

 

7. 가로 정렬

많은 이들이 깔끔하다는 이유로 위와 같이 작성한다.

별로 유용하지 못하다.

엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문이다.

 

차라리 이렇게 사용하자.

 

8. 들여쓰기

if, for 등 다양한 함수에서 들여쓰기를 준수하자.

짧은 코드에서도 들여쓰기를 사용하는것이 좋다.

 

9. 코딩컨벤션

팀끼리 규칙을 정해 코딩 형식, 스타일을 맞추자.

구글에 잘 찾아보면 ide에서 자동으로 포맷팅하는 기능이 있으니 써먹자..