클린코드(형식 맟추기)

클린코드

형식 맞추기

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

형식을 맞추려는 목적

코드 형식은 중요하다. 코드 형식은 의사소통의 일환이다.

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

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

신문기사 처럼 작성하라.

신문은 다양한 기사로 이뤄진다. 대다수 기사가 아주 짧다. 어떤 기사는 조김 길다. 한면을 채우는 기사는 거의 없다.
무작위로 뒤섞인 기사로 이러진 신문이라면 아무도 읽지 않을 것이다.

개념은 빈 행으로 분리하라.

일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어서 분리해야 마땅하다.

세로 밀집도

세로 여백이 개념을 분리한다면 세로 밀집도는 연관성을 의미 한다.

수직 거리

서로 밀접한 개념은 세로로 가까이 두어야 한다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다.
하지만 타당한 근거가 없다면 서로 밀접한 개념은 한파일에 속해야 된다.
이것이 protected를 피해야 하는 이유중 하나다.

변수 선언

변수는 사용하는 위치의 최대한 가까이 선언해야 된다.

인스턴스 변수

인스턴스 변수는 클래스 맨처음에 선언한다. 변수간에 세로 거리를 두지 않는다.

종속함수

한 함수가 다른 함수를 호출한다면 세로로 가까운 거리에 위치 시킨다.

개념적 유사성

어떤 코드는 서로를 끌어드린다. 개념적 유사성이 높기 때문이다.

세로 순서

일반적으로 함수 호출 종속성을 아래 방향으로 유지한다.

가로 형식 맞추기

개인적으로 120자 정도를 제안한다.

가로 공백과 밀집도

가로 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.

가로 정렬

어셈블리어 프로그래머 였던 시절에는 특정 구조를 강조하고자 가로 정렬을 하였다.
하지만 가로정렬이 유용하지 못하다는것을 깨달았다.

정렬이 필요할정도로 목록이 길다면 클래스를 쪼개야 한다는 의미이ㅣ다.

들여쓰기

소스 파일은 outline이랑 계층이 비슷하다. 파일 전체에 적용되는 정보가 있고,
계층내에 적용되는 정보가 있고, 클래스 내에 각 메소드에 적용 되는 정보가 있고,
블록 내에 재귀적으로 적용되는 정보가 있다.

계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다.

들여쓰기 무시하기

짧은 코드 같은 경우 들여쓰기를 무시하고픈 유혹이 있다. 하지만 다시 들여쓰기를 해야된다.

가짜 범위

빈 while문과 for문은 안쓰려는것이 좋고 단행이라고 괄호와 들여쓰기를 하는것이 좋다.

팀규칙

팀은 한가지 규칙을 정하고 팀은 그 규칙을 따라야 한다.

참조