728x90

📖 책 내용 정리

🔶 5장 형식 맞추기

1️⃣ 형식을 맞추는 목적

코드 형식은 의사소통의 일환이다.
구현 스타일과가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.

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

200줄 미만으로도 큰 시스템을 구축할 수 있다.

◾ 신문 기사처럼 작성하라

이름은 간단하면서 설명이 가능하게 짓고 이름만으로도 올바른 모듈을 살펴보고 있는지 아닌지 판단할 수 있도록 한다.
소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명하고 아래로 내려갈수록 의도를 세세하게 묘사한다.
마지막에는 가장 저차원 함수와 세부 내역이 나온다.

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

행은 수식이나 절을 나타내고 일련의 행 묶음은 완결된 생각 하나를 표현한다.
생각 사이에는 빈행을 넣어 분리한다.

◾ 세로 밀집도

밀접한 코드 행은 세로로 가까이 놓여야한다.

◾ 수직 거리

변수는 사용하는 위치에 최대한 가까이 선언한다.
인스턴스 변수는 클래스 맨 처음에 선언하고 변수간에 세로로 거리를 두지 않는다.
종속함수 (한 함수가 다른 함수를 호출)인 경우 두 함수는 세로로 가까이 배치하고
호출하는 함수를 호출되는 함수보다 먼저 배치한다.
개념적 유사성이 높을 수록 코드를 가까이 배치한다. (명명법, 기본기능 등)

◾ 세로 순서

함수 호출 종속성은 아래 방향으로 유지한다.

3️⃣ 가로 형식 맞추기

100 ~120자 정도가 좋다.

◾ 가로 공백과 밀집도

수식에 같은 간격을 적용하고 연산자 우선순위를 고려한다.

◾ 가로정렬

선언문과 할당문을 별도로 정리하지 않는다.

◾ 들여쓰기

클래스 정의처럼 파일 수준인 문장은 들여쓰지 않는다.
클래스 내 메서드는 클래스보다 한 수준 들여쓴다.
메서드 코드는 메서드 선언보다 한 수준 들여쓴다.
블록 코드는 블록을 포함하는 코드보다 한 수준 들여쓴다.

◾ 가짜범위

while( )
;

→ 이런거 쓰지 말자

4️⃣팀규칙

한 소스파일에서 봤던 형식이 다른 소스파일에서도 쓰이리라는 신뢰감을 줘야한다.

5️⃣밥 아저씨의 형식 규칙

💌 책에서 기억하고 싶은 내용

코드 형식은 의사소통의 일환이다

200줄 미만으로도 큰 시스템을 구축할 수 있다.

한 소스파일에서 봤던 형식이 다른 소스파일에서도 쓰이리라는 신뢰감을 줘야한다

💬 소감

내가 WPF 에서 웹 팀으로 옮겨졌을 때, 코드를 엉망진창으로 짰던 기억이 있다.

당시에는 급박하게 코드를 짜느라 아무 생각이 없었는데, 최근에는 만들었던 코드들을 리팩토링 하면서 최대한 일관성있는 형식을 맞추고자 노력하고있다.

다시 되돌아서 그 프로젝트를 되짚어보면 정말 잘되어있었던 것 같다.
학원에서 무지성으로 만들었던 프로젝트를 보면 누가봐도 다른 사람이 짠 코드라는게 티가 확 났었는데,
이 프로젝트의 코드는 누가 짰는지 알 수가 없었다. 그만큼 형식이 정말 한결같았다.

처음부터 깔끔한 코드를 짜면 제일 좋겠지만, 그게아니라면 꾸준하게 코드 리팩토링을하고, 다른사람이 만들어 둔 코드를 보면서 공부하면서, 언젠가는 술술 읽히는 신문처럼 코드를 짜보고싶다.

💥 이해 안 가는 부분

이해가 가지 않거나 어려운 부분은 없었다.