클린 코드 - 5장 형식 맞추기
범위
- 5장 형식 맞추기
요약
- 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
- 프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
책에서 기억하고 싶은 내용
- 코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
- 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽니다.
- 신문 기사처럼 작성하라
- 이름은 간단하면서도 설명이 가능하게 짖는다.
- 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.
- 아래로 내려갈수록 의도를 세세하게 표현한다.
- 마지막에서는 가장 저차원 함수와 세부내역이 나온다.
- 개념은 빈 행으로 분리하라
- 생각 사이는 빈 행을 넣어 분리해야 마땅하다.
- 빈 행은 새로운 개념을 시작한다는 시각적 단서다.
- 세로 밀집도
- 세로 밀집도는 연관성을 의미한다.
- 수직 거리
- 서로 밀접한 개념은 한 파일에 속해야 마땅하다.
- 변수 선언
- 변수는 사용하는 위치에 최대한 가까이 선언한다.
- 인스턴스 변수
- 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요하다. 변수 선언을 어디서 찾을지 모두가 알고 있어야 한다.
- 종속 함수
- 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
- 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
- 상수를 알아야 마땅한 함수에서 실제로 사용하는 함수로 상수를 넘겨주는 방법이 더 좋다.
- 프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
소감
- 코드는 글이며, 개발자의 의사 소통 수단이다. 코드 형식에 따라 의사소통이 얼마나 잘 이뤄질 수 있을 지가 결정된다. 결국 코드는 독자를 생각하며 쉽게 읽을 수 있도록 작성해야 한다는 이야기이다.
This post is licensed under CC BY 4.0 by the author.