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

0. 시작하는 글

: 코딩을 할 때 어떤 형식으로 하는게 중요하다. 

1. 형식을 맞추는 목적

- 코드형식은 중요 : 기능은 바뀔 수 있지만, 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미침

- 맨 처음 만든 코드는 중요 : 뒷 사람들이 참고하니

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

: 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템 구축이 가능

 -> 일반적으로 큰파일보다 작은 파일이 이해하기 쉬움

1) 신문 기사처럼 작성해라

: 신문 독자는 위에서 아래로 기사를 읽음

 -> 소스파일도 신문 기사와 비슷 - 첫부분은 고차원 개념, 알고리즘을 설명하고 내려갈 수록 의도를 세세하게 묘사, 마지막에는 가장 저차원 함수와 세부내역이 나옴

2) 개념은 빈 행(줄)으로 분리하라

: 코드 중 빈 행(줄)은 새로운 개념을 시작한다는 신호임

ex) 예를 들면 같은 클래스 내에서 메소드끼리 한 줄을 띄워주는 것을 말함

3) 새로 밀집도

: 잘 바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미

# 쓸데없이 주석을 넓게 달거나 하면 코드가 한눈에 안들어 옴 

4) 수직 거리

: 서로 밀접한 개념은 세로로 가까이 둬야 함

변수 선언 : 변수 사용 위치는 최대한 가까이 선언

인스턴스 변수 : 클래스 맨 처음에 선언 함 -> 분분한 의견

cf) C++ 

: 모든 인스턴스 변수는 클래스 마지막에 선언 -> 가위 규칙

5) 종속함수 :  한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치

6) 개념적 유사성 

: 종속성이 있어도 같이 배치할 수 있으나, 명명법이 똑같고 기본 기능이 유사하고 간단

7) 세로 순서

: 일반적 함수 호출 종속성은 아래 방향으로 유지

3. 가로 형식 맞추기

: 짧은 행이 바람직. 저자는 개인적으로 120자 정도로 행 길이를 제한 하길 바람

4. 가로 공백과 밀집도

: 가로로는 공백을 사용해 밀집한 개념과 느슨한 개념을 표현

1) 가로 정렬 

: 변수이름이나 피연산자를 정렬하면 아래와 같은 모습임

-> 일반적으로 변수유형은 무시하고 변수 이름부터 읽게 되는데, 아래와 같이 하면 변수 유형이나 피연산자에 눈이 감

ex)

private    Socket            socket

private    InputStream    inputStream;

potected long              criticalNumber

2) 들여쓰기

: 붙여 쓰는 것보다 들여쓰기를 하면 파일 구조가 한 눈에 들어옴

: if, while 짧아도 위의 규칙을 따르는게 좋음

3) 가짜 범위

: 때로는 빈 while문이나 for문을 접하는데, 이러한 경우에도 새미콜론(;)을 새 행에다 제대로 들여써서 넣어주는게 좋음

-> 그렇지 않으면 착각 할 수 있음

ex) while(dis.read(buf, 0, readBufferSize) != -1)

     ;

5. 팀 규칙

:프로그래머는 각자 선호하는 규칙이 있지만, 팀에 속한다면 자신이 선호해야 할 규칙을 따라야 함