5. 형식 맞추기
프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.
형식을 맞추는 목적
코드 형식은 의사소통의 일환이다. 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
적절한 행 길이를 유지하라
오픈소스를 분석해보면 500줄을 넘치않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실이다.
신문 기사처럼 작성하라
이름은 간단하면서도 설명이 가능하게 짓고, 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명하며 아래로 내려갈수록 의도를 세세하게 묘사하라.
개념은 빈 행으로 분리하라.
생각 사이는 빈 행을 넣어 분리해야 마땅하다.
세로 밀집도
세로 밀집도는 연관성을 의미한다. 서로 밀접한 코드 행은 세로로 가까이 놓아야 한다는 뜻이다.
수직거리
서로 밀접한 개념은 세로로 가까이 둬야 한다. 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다. 여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.
- 변수 - 사용하는 위치에 최대한 가까이 선언한다.
- 인스턴트 변수 - 클래스 맨 처음에 선언한다. -> 경우에 따라 다를수도 있지만 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요
- 종속함수 - 한 함수가 다른 함수를 호출한다면 두 함수는 세로 가까이 배치. 호출하는 함수를 호출되는 함수보다 먼저 배치
- 개념적인 유사성 - 친화도가 높을수록 코드를 가까이 배치한다 세로 순서- 함수 호출 종속성은 아래 방향으로 유지
가로 형식 맞추기
짧은 행이 바람직하다 (120자 정도로 행길이 제한)
가로 공백과 밀집도
가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다 할당 연산저를 강조하려고 앞뒤에 공백을 주거나, 연산자 우선순위를 표현하기 위해 공백을 주거나
가로 정렬
별로 유용하지 않음 -> 엉뚱한 부분을 강조해 의도가 가려지기 때문
들여쓰기
소스 파일은 윤곽도와 계층이 비슷하고, 범위로 이루어진 계층을 표현하기 위해 우리는 코드를 들여쓴다. 들여쓰기 한 파일은 구조가 한눈에 들어온다.
가짜 범위
빈 while 문이나 for 문의 경우 -> 피할 수 있음 피하고, 그렇지 못하면 빈 블록을 올바로 들여쓰고 괄호로 감쌈
팀규칙
팀에 속한다면 자신이 선호해야 할 규칙은 팀 규칙하다. 그래야 소프트웨어가 일관적인 스타일을 보인다. 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하라! 스타일은 일관적이고 매끄러워야 한다.
#노개북 #노마드코더 #개발자북클럽