클린 코드 5장: 형식 맞추기

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야한다.

 

구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.

 

적절한 코드 길이

- 파일 크기(행 수) : 작을 수록 좋다. 위처럼 대규모 프로젝트들도 평균 65줄, 대부분 200줄 이하로 구성되어 있다.

- 행 길이 : 작을수록 좋다. 대부분 80자가 넘지 않는다. 저자도 120자 이를 권한다.

 

※ JUnit, FitNesse, testNG, Time and Money, JDepend, Ant, Tomcat의 조사 결과를 기반으로 함.

 

신문 기사처럼 작성해라

- 신문기사는 제목 -> 요약 -> 세부 내용 순으로 작성된다.

- 코드 또한, 이름 -> 개념/알고리즘 -> 세부 내용 순으로 묘사하면 읽기 쉽다.

 

세로 밀집도(세로로 코드를 짜는 방식) 

- 다른 개념은 빈 행을 이용해서 구분하자. 개념을 분리하면 가독성이 높아진다.

- 밀접한 개념일수록 세로로 가까이 둬야한다. 또한, 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 만약, 그렇지 않다면 여러 파일을 뒤지고 여러 곳을 이동하게 된다.

- 종속 함수(함수 내에서 호출 당하는 함수)는 호출하는 함수 근처에 두며, 호출하는 함수를 위에 둔다.

- 개념적인 유사성이 있다면, 근처에 두는 것이 좋다.

- 신문기사와 마찬가지로, 중요한 개념일수록 가장 먼저 표현한다. 세세한 사항일수록 밑에 표현한다.

- 변수 선언부는 사용하는 곳(함수) 근처에 있으면 된다. 단, 우리가 작성하는 코드는 매우 짧으므로, 최상단에 위치하면 편리할 것이다. 

 

* 충돌하는 규칙을 어떻게 처리하는 지 3-7에 예시를 확인하였다.

1). 가장 중요한 개념 함수들이 먼저 나열되고, 다시 세부 호출 함수들이 쭉 나열됨

2). (중요한 개념 함수 > 세부 호출 함수) 들이 쭉 나열됨.

저자는 2번 형식으로 작성하였다. 

실제로 나는 1번으로 작성중인데, 이 경우 계속 왔다갔다 하는 일이 너무 많아서 귀찮았다.

 

팀규칙

- 팀규칙은 반드시 지켜야한다.

- 좋은 소프트웨어 시스템은 읽기 쉬운 문서에서 이어진다는 사실을 기억하기 바란다.