- 규칙을 정하고 규칙을 따르며 코딩하여 형식이 깔끔한 코드를 짜야함
- 필요하다면 규칙이 자동으로 적용되는 도구를 활용
형식을 맞추는 목적
- 코드 형식은 의사소통의 일환, 의사소통은 일차적인 의무사항
- 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높음
- 오랜시간이 지나 원래 코드의 흔적을 찾아보기 힘들지라도 처음에 잡아놓은 구현스타일과 가독성 수준은 유지보수의 용의성과 확장성에 영향을 미침
- 이를 위해서는 다음과 같은 규칙을 지킴
적절한 행 길이를 유지하라
- 500줄을 넘기지 않고 200줄 정도의 파일로도 커다란 시스템을 구축할 수 있음
- 일반적으로 큰파일 보다는 작은 파일이 이해하기 쉬움
신문 기사처럼 작성하라
- 이름이 간단하면서도 설명가능하게 지어야함
- 이름만 보고도 올바른 모듈을 살펴보고 있는지 판단할 정도로 신경써서 지음
- 아래로 내려갈수록 의도를 세세하게 묘사
- 마지막에는 가장 저차원의 함수와 세부내역이 나옴
개념은 빈 행으로 분리하라
- 코드는 왼쪽에서 오른쪽, 위에서 아래오 읽힘
- 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각하나를 표현
- 생각사이는 빈행을 넣어 분리해야 마땅함
세로밀집도
- 줄 바꿈과 단대로 서로 밀접된 코드는 세로로 가까이 놓여야함
- 필요이상의 줄바꿈을 해서는 안됨
수직 거리
- 변수는 사용하는 위치에 최대한 가까이 선언
- 인스턴스 변수는 클래스 처음에 선언
- 한 함수가 다른 함수를 호출하면 두 함수는 세로로 가까이 배치
세로 순서
- 일반적으로 함수 호출 종속성은 아래 방향으로 유지
- 즉 호출되는 함수를 호출하는 함수보다 나중에 배치
가로형식 맞추기
가로 공백과 밀집도
가로 정렬
들여쓰기
가짜 범위
팀 규칙
- 팀에 속한다면 자신이 선해해야할 규칙은 바로 팀 규칙
- 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이루어짐
- 스타일은 일관적이며 매끄러워야함
- 한 소스에서 봤던 형식이 다른소스에도 쓰이리라는 신뢰감을 독자에게 줘야함
밥 아저씨의 형식 규칙
References