클린코드 - 형식 맞추기

형식을 깔끔하게 맞춰 코드를 짜야한다.

형식을 맞추는 목적

• 융통성 없이 맹목적으로 따르면 X
• 코드의 형식은 의사소통의 일환
• 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 영향을 줌
• 코드가 많이 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 영향을 미침

원활한 소통을 장려하는 코드형식이란

적절한 행 길이

• 200줄 정도의 파일로도 커다란 시스템을 구축 할 수 있다.
• 작은 파일이 이해하기 쉽다.

신문 기사처럼 작성

• 이름은 간단하면서 설명이 가능하게 작성
• 이름만 보고도 올바른 모듈을 살펴보고 있는지 판단 가능하게
• 소스파일의 첫 부분은 고차원 개념과 알고리즘 설명
• 아래로 내려갈 수록 의도를 세세하게 묘사
• 마지막에는 가장 저차원 함수와 세부 내역
• 짧은 양의 다양한 기사로 이루어진 신문

개념은 빈 행으로 분리

• 생각 사이는 빈 행을 넣어 분리해라

세로 밀집도

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

수직 거리

• 서로 밀접한 개념은 세로로 가까이 두어야 한다.
• 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 한다.
• 변수는 사용하는 위치에 최대한 가까이 선언한다.
• 인스턴스 변수는 클래스 맨 처음에 선언한다. (변수 간에 세로로 거리를 두지 않는다.)
• 한 함수가 다른 함수를 호출하는 종속함수라면 두 함수는 세로로 가까이 배치한다.
  (호출 하는 함수를 호출되는 함수보다 먼저 배치한다.)
• 친화도가 높을 수록 코드를 가끼이 배치한다.
  친화도가 높다는 의미는
  
  • 한 함수가 다른함수를 호출해 생기는 종속성
  • 변수와 그 변수를 사용하는 함수
  • 비슷한 동작을 수행하는 일군의 함수
    
    • 명명법이 똑같고
    • 기본 기능이 유사하고 간단하다.

가로 형식 맞추기

• 짧은 행이 바람직하다. 
  (80 ~ 100 ~ 120자)
• 오른쪽으로 스크롤할 필요가 절대로 없게 코드를 짜지만 요즘은 모니터가 아주 크다.
• 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
• 연산자 우선순위를 강조하기 위해서도 공백을 사용한다.
• 가로정렬은 하지 않는다.

들여쓰기

• 범위로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다.
• 파일 수준인 문장은 들여쓰지 않는다.
• 클래스 내 메서드는 클래스보다 한 수준 들여쓴다.
• 메서드 코드는 메서드 선언보다 한 수준 들여쓴다.
• 블록 코드는 블록을 포함하는 코드보다 한 수준 들여쓴다.
• 짧은 함수에서 들여쓰기 규칙을 무시하고 싶은 유혹이 생기는데 그래도 들여쓰기 범위를 제대로 표현

팀 규칙

• 개인적으로는 lint 사용