클린코드 5장 형식 맞추기

kimjunkyung·2021년 8월 5일

스터디 클린코드

클린코드

목록 보기

6/15

노션에서 정리한 내용을 벨로그로 옮겼기 때문에 노션으로 보면 조금 더 보기 더 편합니다🤗

이동하기 → junnkk's Notion

프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.

코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 따른다. 팀 규칙을 따라야 하고 자동화 도구를 활용한다.

형식을 맞추는 목적

코드의 형식은 중요하다!

가독성은 앞으로 바뀔 코드의 품질에 영향을 미친다.

시간이 지나더라도 처음의 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 영향을 미친다.

적절한 행 길이를 유지하라

신문 기사처럼 작성하라
- 이름은 간단하면서도 설명이 가능하게
- 아래로 내려갈수록 의도를 세세하게 묘사. 마지막에는 가장 저차원 함수와 세부 내역
- 짧게
개념은 빈 행으로 분리하라

코드의 각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현.

→ 생각 사이는 빈 행을 넣어 분리한다. 즉, 행 묶음 분리.
세로 밀집도
- 줄 바꿈→ 개념 분리
- 새로 밀집도 → 연관성을 의미
  
  ⇒ 서로 밀접한 코드 행은 세로로 가까이 놓아야 함.
수직 거리

연관성: 한 개념을 이해하는 데 다른 개념이 중요한 정도
- 서로 밀접한 개념은 세로로 가까이 두어야 한다.
- 서로 밀접한 개념은 한 파일에 속해야 한다. (→ protected 변수를 피해야 하는 이유)
  
  ⇒ 같은 파일에 있을 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현
- 변수 선언
  
  → 변수는 사용하는 위치에 최대한 가까이 선언
- 인스턴스 변수
  
  → 인스턴스 변수는 클래스 맨 처음에 선언 (변수 간에 세로로 거리를 두지 않는다)
  - 가위 규칙: C++ 에서 주로 적용하는 모든 인스턴스 변수는 클래스의 마지막에 선언한다는 규칙
- 종속 함수
  
  → 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치.
  
  → 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치
- 개념적 유사성
  
  → 친화도가 높을수록 가까이 배치
  - 친화도가 높은 요인
    1. 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성
    2. 변수와 그 변수를 사용하는 함수
    3. 명명법이 같고 기본 기능이 유사하고 간단한 경우
세로 순서

일반적으로 함수 호출 종속성은 아래 방향으로 유지 → 함수를 호출하는 함수를 호출하는 함수보다 먼저

⇒ 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려

가로 형식 맞추기

프로그래머들은 짧은 행 선호

가로 공백과 밀집도

공백을 사용해 밀접한 개념과 느슨한 개념은 표현

예시) p 108~109

→ 할당 연산자를 강조하기 위해 앞뒤 공백
가로 정렬

가로 정렬 사용 X
들여쓰기

계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위이다.

→ 범위로 이루어진 계층을 표현하기 위해서 들여쓰기 사용
- 들여쓰는 정도는 계층에서 코드가 자리 잡은 수준에 비례
  
  → 클래스 정의처럼 파일 수준인 문장은 들여쓰기 X
  
  → 클래스 내 메서드는 클래스보다 한 수준 들여쓰기
  
  → 메서드 코드는 메서드 선언보다 한 수준 들여쓰기
  
  → 블록 코드는 블록을 포함하는 코드보다 한 수준 들여쓰기
- 들여쓰기 무시하기
  
  무시하면 안됨!
가짜 범위

빈 while이나 for문 → 새 행에다가 제대로 들여써서 (;) 해주기