5장 - 형식 맞추기

• 깔끔하게 보기 좋은 코드를 만들자.
• 간단한 규칙을 정하고 규칙을 착실히 따라야 한다.
• 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 따라야한다.
• 자동으로 적용하는 도구를 활용하자.
• ( 우리회사는 구글 형식맞추는거 사용 )

1. 형식을 맞추는 목적

   • 코드의 형식은 중요하다 너무중요하다.

2. 적절한 행길이를 유지하라

   • 클래스 하나가 500줄을 넘지 않고 대부분 200줄로만 짜고도

   • 커다란 시스템을 구축할수 있다.

   • 일반적으로 큰파일보다 작은파일이 이해하기가 쉽다.

   • 신문기사 처럼 작성하라.

     • 이름은 간단하면서도 설명이 가능하게 짓는다.
     • 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
     • 소스 파일 첫부분은 고차원 개념과 알고리즘을 설명한다.
     • 아래로 내려갈수록 의도를 세세하게 묘사한다.
     • 마지막에는 가장 저차원 함수와 세부내역이 나온다.

   • 개념은 빈행으로 분리하다.

     • 거의 모든 코드는 왼쪽에서 오른쪽 그리고 위에서 아래쪽으로 읽힌다.
     • 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다.
     • 생각 하나 사이에는 빈 행을 넣어 분리해야 마땅하다.
     • 빈 행은 새로운 개념을 시작한다는 시각적 단서다.
     • ( 말 멋있다. )

   • 세로 밀집도

     • 줄바꿈이 개념을 분리 한다면 세로 밀집도는 연관성을 의미한다.
     • 즉 서로 밀집한 코드행은 세로로 가까이 놓여야 한다는 뜻이다.
     • 변수나 일급컬렉션 메소드 이 3개도 붙여야된다. 연관되어있다면.

   • 수직거리

     • 서로 밀집한 개념들은 세로로 가까이 둬야 한다.
     • 서로 밀집한 개념들은 한파일에 속해야 마땅하다.
     • protected 변수를 피해야 되는 이유.
     • ( protected 변수를 쓰면 같은 패키지내에서 쓸수 있으니까. )

   • 변수선언

     • 변수는 사용하는 위치에 최대한 가까이 선언한다.
     • 루프문을 제어하는 변수는 흔히 루프 문 내부에 선언한다.

   • 인스턴스 변수

     • 반면 인스턴스 변수는 클래스 맨 처음에 선언한다.
     • 변수간에 세로로 거리를 두지 않는다.
     • 잘 설계한 클래스는 많은 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.

   • 종속 함수

     • 한 함수가 다른 함수를 호출 한다면 두 함수는 세로로 가까이 배치한다.
     • 또한 그낭하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
     • 첫째 함수에서 호출하는 첫번째 함수가 바로 아래 정의된다.
     • 그다음은 그아래 정의된다.
     • 그러므로 호출되는 함수를 찾기가 쉬워지며 그만큼 모듈 전체의 가독성도 높아진다.

   • 개념의 유사성

     • 비슷한 동작을 수행하는 일군의 함수들
     • 명명법이 비슷하고 기본 기능이 유사한것들
     • 종속적인 관계가 없더라도 가까이에 배치해야될 함수

   • 세로 순서

     • ( 좀 어렵다 )
     • 호출되는 함수를 호출하는 함수보다 나중에 배치한다.
     • 그러면 소스코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.

   • 가로형식 맞추기

     • 한 행은 가로로 얼마나 길어야 적당할까 ?
     • 글쓴이 할아버지는 120자정도로 행길이를 제한함.

   • 가로 공백과 밀집도

     • aa(String a)
     • 이것처럼 함수안에 인자는 괄호 사이에 공백을 넣지 말자.
     • 여러개일경우는 우선순위를 강조하기 위해서 공백을 사용한다.
     • 연산자 ( + - 같은것들 ) 은 우선순위 강조를 위해 띄어 쓴다.

   • 가로 정렬

     • 선언문과 할당문을 별도로 정렬하면 보기가 안좋다
     • 예) String a;
     • 예) Long b;
     • 예) Integer c;
     • 정렬이 필요할 정도로 목록이 길다면 클래스를 쪼개야 된다는 의미다.

   • 들여쓰기

     • 범위로 이루어진 계층을 표현하기 위해 우리는 코드를 들여 쓴다.
     • 들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.
     • 클래스 정의처럼 파일 수준인 문장은 들여 쓰지 않는다.
     • 클래스 내 메서드는 클래스보다 한 수준 들여 쓴다.
     • 메서드 코드는 메서드 선언보다 한 수준 들여 쓴다.
     • 블록 코드는 블록을 포함하는 코드보다 한 수준 들여 쓴다.

   • 들여쓰기 무시하기

     • 간단한 if문 짧은 while문 짧은 함수에서 들여쓰기 규칙을 무시하면 안된다.
     • 한행에 범위를 뭉뚱그린 코드를 피한다
     • 예) public String render() throws Exception { return ""; }

   • 가짜 범위

     • 때로는 빈 while문이나 for문을 접한다.
     • 제대로 들여쓰기해서 써줘라.

   • 팀 규칙

     • 팀이 규칙을 정했으면 팀원은 그 규칙을 정해야 한다.