[클린코드] TIL - 5장 형식 맞추기

🖤 TIL (Today I Learned)

• 형식을 맞추는 목적
  • 코드의 가독성
  • 유지보수 용이성과 확장성
• Rules
  • 적절한 행 길이 유지
    • Tomcat 같은 경우 200 ~ 500 줄 안으로 커다란 시스템을 구축할 수 있음
    • 신문 기사 처럼 첫 부분은 고차원 개념 -> 마지막에 가장 저차원 함수와 세부 내역으로 작성
    • 공통된 개념은 빈 행으로 분리하라
  • 세로 밀집도 : 연관성을 의미  (밀접한 코드 행은 세로로 가자이 하라)
    
    • 연관성 : 한 개념을 이해하는 데 다른 개념이 중요한 정도. 붙여놓기
    • 변수 선언 : 사용하는 위치에 최대한 가까이 하기
    • 인스턴스 변수 : 클래스 맨 처음에 선언
    • 종속 함수 : 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치. 호출하는 함수를 먼저 배치
  • 가로 형식 맞추기 : 최대 120자 정도로 행 길이 제한
    • 중요한 개념이라면 가로 공백을 둬서 두 가지 주요 요소를 확실히 나누기 (자동 inspector는 줄이려고 할 것)
    • 들여쓰기 사용
    • 가짜 범위 : eg. while이 괄호가 아닌 들여쓰기로 사용될때 ; 를 한 단계 밑ㅇ로 제대로 들여쓰기 하여 눈에 띄게 하기

while (dis.read(buf, 0, readBufferSize) != -1)
; // 제대로 들여쓰기

• 팀 규칙 잘 따르기

 

🤍 오늘 읽은 범위

5장 형식 맞추기

🩷 기록

private method를 사용하는 publid method 바로 밑에 둘지, 아니면 맨 밑에 private method 끼리 묶어둘지를 고민을 많이 했었다. 이 책에서는 연관성이 높은 함수들을 묶어서 놓아야 가독성이 높아진다고 이야기하고 있다. 일정 부분 이해하지만 사실 현재 IDE 에서는 함수를 파고 들어가는 일이 어려운 일은 아니다. 특히 해당 private method를 여러 함수에서 공통으로 사용한다면 결국에는 밑으로 밀려나는 일은 아닌가? 어떤게 개발자에게 가독성을 높이는 일인지 좀 더 고민을 하게 되는 계기가 되었다.