본문 바로가기

공부/노개북

[노개북] '클린 코드' Assignment #08

📌 2 주차
월 | Assignment #8
- 📖 5장. 형식 맞추기
- 📝 TIL

💡 TIL (Today I Learned)

2022.02.28.월

📖 오늘 읽은 범위

5장. 형식 맞추기

  책에서 기억하고 싶은 내용을 써보세요.

  • 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다. - p.96
  • 형식을 맞추는 목적 : 코드 형식은 의사소통의 일환이며 너무 중요하다! 오랜 시간이 지나 원래 코드보다 많이 변경되어도 처음 잡아놓은 구현 스타일과 가독성은 유지보수 용이성과 확장성에 계속해서 영향을 미치며, 개발자의 스타일과 규율은 사라지지 않는다. - p.96
  • 적절한 행 길이를 유지하라 : 500줄이 넘지 않고도 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다. 일반적으로는 큰 파일보다 작은 파일이 이해하기 쉽다. - p.96
  • 신문 기사처럼 작성하라 : 소스 파일도 신문 기사와 비슷하게 작성한다. 신문은 다양한 기사로 이뤄지며 대다수 기사가 아주 짧다는 사실을 기억해야 한다. - p.98
  • 신문 기사 : 기사를 요약하는 표제 -> 첫 문단은 기사를 요약한 내용 -> 밑에 세세한 내용들
  • 파일 : 이름을 간단하고 설명이 가능하게 -> 개념과 알고리즘을 설명 -> 함수와 세부 내역
  • 개념은 빈 행으로 분리하라 : 빈 행을 넣어 분리해야한다. 빈 행은 새로운 개념을 시작한다는 시각전 단서이다. 코드를 읽어 내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈추게 된다. 빈 행을 빼버리면 가독성이 현저하게 떨어지게 된다.- p.98
  • 세로 밀집도 : 세로 밀집도는 연관성을 의미한다. 서로 밀집한 코드 행은 세로로 가까이 놓여야 한다. - p.100
  • 수직 거리 : 시스템을 이해하기 위하여 여기 저기 어디에 있는지 찾고 기억하는 것은 시간과 노력을 소모시킨다. 서로 밀집한 개념은 세로로 가까이 두어야 한다. 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다. - p.101
  • 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성(한 개념을 이해하는데 다른 개념이 중요한 정도)을 표현한다. - p.101
  • 변수 선언 : 변수는 사용하는 위치에 최대한 가까이 선언한다. 루프를 제어하는 변수는 루프 문 내부에 선언한다. - p.101
  • 인스턴스 변수 : 인스턴스 변수는 클래스 맨 처음에 선언한다. C++에서는 마지막에 선언하는 가위 규칙을 적용하지만 자바에서는 보통 클래스 맨 처음에 인스턴스를 선언한다. 알려진 위치에 인스턴스를 위치시키는게 중요하다. - p.103
  • 종속 함수 : 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 호출되는 함수를 찾기가 쉬워지며, 모듈 전체의 가독성도 높아진다. - p.104
  • 개념적 유사성 : 개념적인 친화도가 높을수록 코드를 가까이 배치한다. 한 함수가 다른 함수를 호출해서 생기는 직접적인 종속성, 변수와 변수를 사용하는 함수, 명명법이 똑같고 기본 기능이 유사한 것으로 종속적인 관계가 없더라도 가까이 배치할 수 있다. - p.106
  • 세로 순서 : 함수 호출 종속성은 아래 방향으로 유지한다. 신문 기사와 마찬가지로 가장 중요한 개념을 가장 먼저 표현한다. - p.106
  • 가로 형식 맞추기 : 한 행의 가로길이는 보통 45자로 프로그래머는 짧은 행을 선호한다. 개인적으로 120자 정도로 행 길이를 제한하는걸 권한다. - p.107
  • 가로 공백과 밀집도 : 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 사실이 분명해진다. 함수 이름과 이어지는 괄호 사이에 공백을 넣으면 한 개념으로 보이지 않아 넣지 않는다. 연산자 우선순위 강조를 위하여 덧셈과 뺄셈에는 공백을 주고 우선순위인 곱셈과 나눗셈에는 적용하지 않는다. - p.108
  • 가로 정렬 : 가로 정렬은 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지게 한다. 정렬이 필요할 정도로 목록이 길다면 길이를 조정해야하지 정렬의 문제가 아니다. - p.109
  • 들여쓰기 : 계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다. 범위로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다. 클래스 -> 클래스 내 메서드, 메서드 선언 -> 메서드 코드, 블록을 포함한 코드 -> 블록 코드 들여쓰기한 파일은 구조가 한눈에 들어온다. - p.111
  • 들여쓰기 무시하기 : 간단한고 짧은 함수에서 들여쓰기 규칙을 무시하고픈 유혹이 생기지만 들여쓰기를 넣는 것이 좋다. - p.112
  • 가짜 범위 : 빈 while, for문을 피할 수 업다면 빈 블록을 올바로 들여쓰고 괄호로 감싼다. 세미콜론은 새 행에다 재대로 들여써서 넣어준다. - p.113
  • 팀 규칙 : 프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 팀 규칙이다. 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하며 온갖 스타일을 섞어 코드를 복잡하게 만드는 실수를 피해야 한다. - p.113

📝 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

  • 혼자서 코드를 배우다보니 코드에 대한 규칙을 알지 못했다. 최근에서야 빈 행에 대하여 알게 되었다. 가독성을 높이기 위해 한 부분씩 띄어서 사용했다. 그 가독성이 적용된 사람은 오로지 나혼자뿐이란 생각을 하지 못한 것 같다. 
  • 다른 사람들의 코드를 배우면서 하나씩 알아가는게 있었는데 이렇게 규칙에 대해서 명확히 설명되어 있어서 코드에 순서에 대해서 알 수 있어서 좋았다. 배운 부분들을 현업에 적용하고 이해할 수 있다는 부분에서 스터디를 한 보람을 느끼고 있어서 뿌듯하다🤗🤗

🔎 궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.