Clean Code 05장. 형식 맞추기
TIL(Today I Learn)
2024.06.29
오늘 읽은 범위
5장. 형식 맞추기
책에서 기억하고 싶은 내용을 써보세요.
형식 맞추기
코드 형식에 대한 규칙을 정하고 해당 규칙에 맞춰서 코딩하는 것은 중요하다.
코드 형식을 강제 할 수 있는 자동화된 도구를 사용하는 것은 반드시 도움이 된다.적정한 행 길이를 유지하라.
일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
(대부분 200줄 정도인 파일들로 대규모 시스템을 구축한 사례 ex. FitNesse)신문 기사처럼 작성하라.
이름은 간단하면서도 설명이 가능하게 짓는다.
첫 부분은 고차원 개념과 알고리즘을 설명한다.
아래로 내려갈수록 의도를 세세하게 설명한다.
마지막에는 가장 저차원 함수와 세부 내역을 설명한다.개념은 빈 행으로 분리하라.
코드 사이사이에 빈 행이 들어가며, 이는 새로운 개념이 시작된다는 의미이다.세로 밀집도
서로 밀접한 코드 행은 세로로 가까이 위치해야 한다.수직 거리
서로 밀접한 개념은 세로로 가까이 위치해야 한다.
서로 밀접한 개념은 한 파일에 속해야 마땅하다.
같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.변수 선언
변수는 사용하는 위치에 최대한 가까이 선언한다.
지역 변수는 각 함수 맨 처음에 선언한다.인스턴스 변수
인스턴스 변수는 클래스 맨 처음에 선언한다.
즉, 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요하다.종속 함수
한 함수가 다른 함수를 호출하면, 두 함수는 세로로 가까이 배치한다.
호출하는 함수를 호출되는 함수보다 먼저 배치한다.개념적 유사성
친화도가 높을수록 코드를 가까이 배치한다.
한 함수가 다른 함수를 호출한다면 친화도가 높다.
변수가 있고, 그 변수를 공유하는 함수는 친화도가 높다.
명명법이 똑같고 기본 기능이 유사하다면 친화도가 높다.가로 형식 맞추기
프로그래머는 명백하게 짧은 길이를 선호한다.
80자는 너무 짧으며, 120자 정도가 괜찮다고 생각한다.가로 공백과 밀접도
공백을 사용하여 밀접한 개념과 느슨한 개념을 표현한다.
할당문은 왼쪽 요소와 오른쪽 요소가 분명히 나뉜다. (공백 필요)
함수 이름과 이어지는 괄호 사이에 공백을 넣지 않는다. (공백 불필요)
연산자 우선순위 강조를 위해 공백을 사용할 수 있다.가로 정렬
코드가 엉뚱한 부분을 강조하여 진짜 의도가 가려진다.
정렬이 필요할 정도로 목록이 길다면 이는 길이 문제이지 정렬 문제는 아니다.들여쓰기
범위로 이루어진 계층을 표현하기 위해 코드를 들여쓴다.
왼쪽으로 코드를 맞춰 코드가 속하는 범위를 시각적으로 표현한다.팀 규칙
팀에 소속되어 일한다면 선호해야 할 규칙은 바로 팀 규칙이다.
팀은 한 가지 규칙에 합의해야 하며, 모든 팀원은 그 규칙을 따라야 한다.
훌륭한 소프트웨어는 읽기 쉬운 문서로 이루어져 있다.
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요.
기능적으로 문제 없는 코드라도 이런 기본적인 부분들을 제대로 신경쓰지 않는다면,
클린 코드가 될 수 없다는 것을 배울 수 있었다.코드 형식은 선호하는 스타일이 제각각인 만큼, 프로젝트 시작 전에 팀에서 명확하게 정하고,
팀원들이 반드시 따를 수 있도록 규칙을 정하는 것이 중요하다.
궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
- 팀원들 간에 코드 형식을 일치시키기 위해서 IDE의 어떤 도움을 받을 수 있을까?