TIL (Today I Learned)

2022.3.1

오늘 읽은 범위

5장 형식 맞추기

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

• 형식을 맞추는 목적- 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도, 맨처음 잡아놓은 구현 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다. (P.96)

  500 줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실이다. (P.97)

• 소스파일도 신문 기사와 비슷하게 작성한다. 이름은 간단 하면서도 설명이 가능하게 짓는다. 이름만 보고도 올바른 모듈을 살펴보고 있는 지 아닌지를 판단 할 정도로 신경 써서 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다. (P.98)

• 빈 행은 새로운 개념을 시작한다는 시각적 단서다. 코드를 읽어 내려가다 보면 빈 행 바로 다음 줄에 눈길이 멈춘다. (P.98)

• 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.

  (P.100)

• 연관성이 깊은 두개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스파일과 클래스를 여기저기 뒤지게 된다. (P.101)

• 변수선언 - 변수는 사용하는 위치에 최대한 가까이 선언한다. (P.101)

• 인스턴스 변수- 인스턴스 변수는 클래스 맨처음에 선언한다. 변수 간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 많은(혹은 대다수)클래스 메서드가. 인스턴스 변수를 사용하기 때문이다.(P.103)

• 종속함수 - 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다. 규칙을 일관적으로 적용한다면 독자는 방금 호출한 함수가 잠시후에 정의되리라는 사실을 예측한다. (P.104)

• 일반적으로 함수 호출 종속성은 아래방향으로 유지한다. (P.106)

• 소스파일은 윤곽도와 계층이 비슷하다. 파일 전체에 적용되는 정보가 있고, 파일내 개별클래스에 적용되는 정보가 있고, 클래스 내 각 메서드에 적용되는 정보가 있고, 블록 내 블록에 재귀적으로 적용되는 정보가 있다. 계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다. (P.111)

• 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다. 개개인이 따로국밥처럼 맘대로 짜대는 코드는 피해야 한다.(p.113)

• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다. 온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피한다.(p.114)

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

• 코드를 심플하고 아름답게 만들기 위해서, 유지보수 시 어려움을 느끼지 않게 하기 위해서 작성하는 코드는 누구나 알아보기 쉽게 정의, 수정, 정리가 필요하다.

• 불필요한 내용은 바로바로 삭제하고 간결하고 코드가 적지만 유용하게 만들겠다.

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