코드 형식은 중요하다!
📌 적절한 행 길이를 유지하라
일반적으로 큰파일보다 작은 파일이 이해하기 쉽다.
신문 기사처럼 작성하라
이름은 간단하면서도 설명이 가능하게 짓는다. 소스 파일 철 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈 수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부내역이 나온다.
개념은 빈 행으로 분리하라
거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다. 각 행은 수식이나 절을 나타내고, ㅣ련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다
세로 밀집도
줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉 서로 밀접한 코드 행은 세로로 가까이 놓여야한다는 뜻이다.
변수 선언
변수는 사용하는 위치에 최대한 가까이 선언한다. 우리가 만든 함수는 매우 짧으므로 지역 변수는 각 함수 맨 처음에 선언한다.
인수턴스 변수
인스턴스 변수는 클래스 맨 처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 클래스의 많은 메서드가 인스턴스 변수를 사용하기 때문이다.
종속 함수
한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
개념적 유사성
친화도가 높을수록 코드를 가까이 배치한다.
세로 순서
일반적인 함수 호출 종속성은 아래 방향으로 유지한다. 다시 말해 호출되는 함수를 호출하는 함수보다 나중에 배치한다. 그러면 소스 코드 모듈이 고차원에서 저자원으로 자연스럽게 내려간다.
📌 가로형식 맞추기
짧은 행 선호 한다. 개인적으로 120자 정도로 행 길이를 제한한다.
가로 공백과 밀집도
가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
가로 정렬
정렬이 필요할 정도로로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다. 선언부가 길다면 클래스를 쪼개야 한다는 의미다.
들여쓰기
소스 파일은 윤곽도와 계층이 비슷하다.
범위로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다. 들여 쓰기 정도는 계층에서 코드가 자리잡은 수준에 비례한다.
📌 팀규칙
팀은 한 가지 규칙에 합의해야한다. 그리고 모든 팀원은 그 규칙을 따라야 한다.
좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다.
사실 형식 맞추는거 가볍게 생각했는데 앞으로 신경을 좀 써보려고 한다!
