Chapter 5. 형식맞추기

뚜껑을 열었을 때 독자들이 코드가 깔끔하고, 일관적이며, 꼼꼼하다고 감탄하면 좋겠다. 질서 정연하다고 탄복하면 좋겠다.

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야한다. 형식을 맞추기 위해 간단한 규칙을 정하고 그 규칙에 착실히 따라야 한다. 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 할것이다. 필요하다면 규칙을 자동으로 적용하는 도구를 활용한다.

형식을 맞추는 목적

코드의 형식은 중요하다.! 너무나도 중요하므로 융통성없이 맹목적으로 따르면 안된다. 코드형식은 의사소통의 일환이다. 의사소통은 전문개발자의 일차적인 의무이다.

가령, 오늘 구현한 기능이 다음 버전에서 바뀔 가능성이 농후하다. 그런데 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다. 원래 코드는 사라질지 라도 개발자의 스타일과 규율은 사라지지 않는다.

1. 적당한 행의 길이는? 어떻게 작성해야할까?

소스코드는 얼마나 길어야 적당할까? 대다수 자바 소스 파일 크기는 어느정도일까? 500줄을 넘지 않고 대부분은 200줄인 파일로 커다란 시스템을 구축할 수 있다. 반드시 지킬 엄격한 규칙은 아니지만 바람직한 규칙으로 삼으면 좋겠다. 일반적으로 큰 파일 보다 작은 파일이 이해하기 쉽다.

좋은 신문기사를 떠올려보면, 독자는 위에서 아래로 기사를 읽는다. 최상단에 기사를 몇마디로 요약하는 표제와 표제를 보고 기사를 읽지 말지 결정한다. 소스파일도 마찬가지로 비슷하게 작성한다. 이름은 간단하면서도 설명이 가능하게 짓는다. 이름만 보고 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경써서 짓는다. 소스파일 첫부분은 고차원 개념과 알고리즘을 설명하고 아래로 내려갈수록 의도를 세세하게 묘사한다.

2. 개념

개념은 빈 행으로 분리해야한다. 거의 모든 코드는 왼쪽에서 오른쪽, 위에서 아래로 읽는다. 각 행은 수식이나 절로 일련의 행 묶음은 완결된 생각 하나를 표현한다. 빈 행은 새로운 개념을 시작한다는 시각적인 단서이다. 코드를 읽어 내려가다 보면 빈행 바로 다음 줄에 눈길이 멈춘다.

확실히 function 이 여러번 빈 행 없이 붙어있는것보다 따로 떨어져 있다면 좀더 깔끔하고 보기 쉬운것 같다.

3. 변수 선언

변수 선언 변수는 사용하는 위치에 최대한 가까이 선언한다. 우리가 만든 함수는 매우 짧으므로 지역 변수는 각 함수 맨 처음에 선언한다. 예를 들면 루프를 제어 하는 변수는 흔히 루프 내부에서, 아주 드물지만 다소 긴 함수에선 블록 상단이나 , 루프 직전에 변수선언한다. 반면, 인스턴스 변수는 클래스 맨처음에 선언되며, 변수간 거리를 두지않는다. 아직 인스턴스 변수는 그 위치가 논쟁이 분분하다. 일반적으로 마지막에 선언된다.

4. 종속 함수

종속함수. 함수가 다른 함수를, 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 규칙을 일관적으로 배치한다면, 독자는 호출한 함수가 잠시후 정의되리란 사실을 예측하게 된다. 호출되는 함수를 찾기 쉬워지며, 그만큼 모듈 전체의 가독성도 높아진다.

5. 팀 규칙

팀은 한 가지 규칙에 합의해야한다. 그리고 모든 팀원은 그 규칙을 따라야 하며, 소프트웨어가 일반적인 스타일을 그래야 보인다.

느낀점

이번 단원도 결론이 따로 없다. 느낀점을 간단히 적는다면 좋은 소프트웨어 시스템은 읽기쉬운 문서로 이뤄진다는점. 일관적인 들여쓰기, 내여쓰기,띄어쓰기, 가로행의 길이 , 세로행의 길이는 일관적이고 매끄럽게 느껴지게 한다. 그리고 그 더 나아가 , 소스파일에도 이 파일이 쓰이겠구나..라는 생각도 든다.