TIL (Today I Learned)

2022.02.28

오늘 읽은 범위

5장. 형식 맞추기

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

코드 형식은 중요하다!

오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.

적절한 행 길이를 유지하라

자바에서 파일 크기는 클래스 크기와 밀접하다.

일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

신문 기사처럼 작성하라

소스 파일도 신문기사와 비슷하게 작성한다.

• 이름은 간단하면서도 설명이 가능하게 짓는다.

• 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.

• 소스파일 첫 부분은 고차원 개념과 알고리즘을 설명한다.

• 아래로 내려갈수록 의도를 세세하게 묘사한다.

• 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

개념은 빈 행으로 분리하라

일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다.

빈 행은 새로운 개념을 시작한다는 시각적 단서다.

세로 밀집도

줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.

서로 밀접한 코드 행은 세로로 가까이 놓아야 한다는 뜻이다.

수직 거리

서로 밀접한 개념은 세로로 가까이 뒤야 한다. 물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다. 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다.
이게 바로 protected 변수를 피해야 하는 이유 중 하나다.

같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.

여기서 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도다.

변수선언

변수는 사용하는 위치에 최대한 가까이 선언한다.

• 지역 변수를 각 함수 맨 처음에 선언한다.

• 루프를 제어하는 변수는 흔히 루프 문 내부에 선언한다.

인스턴스 변수

인스턴스 변수는 클래스 맨 처음에 선언한다.

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

자바에서는 보통 클래스 맨 처음에 인스턴스 변수를 선언한다.

종속 함수

한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.

개념적 유사성

어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다.

친화도가 높을수록 코드를 가까이 배치한다.

• 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성

• 변수와 그 변수를 사용하는 함수

• 명명법이 똑같고 기본 기능이 유사하고 간단

세로 순서

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

호출되는 함수를 호출하는 함수보다 나중에 배치한다.

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

가로 형식 맞추기

프로그래머는 명백하게 짧은 행을 선호한다.

가로 공백과 밀집도

가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.

• 할당 연산자를 강조하려고 앞뒤에 공백을 줬다.

• 함수 이름과 이어지는 괄효 사이에는 공백을 넣지 않았다.

• 함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리했다.

• 연산자 우선순위를 강조하기 위해서도 공백을 사용한다.

가로 정렬

정렬이 필요한 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.
선언부가 길다면 클래스를 쪼개야 한다는 의미다.

들여쓰기

범위(scope)로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.

들여쓰는 정보는 계층에서 코드가 자리잡은 수준에 비례한다.

• 클래스 정의처럼 파일 수준인 문장은 들여쓰지 않는다.

• 클래스 내 메서드는 클래스보다 한 수준 들여쓴다.

• 메서드 코드는 메서드 선언보다 한 수준 들여쓴다.

• 블록 코드는 블록을 포함하는 코드보다 한 수준 들여쓴다.

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

팀에서의 코드 형식에 강제성을 부여하진 않았다. 각자의 코딩 스타일을 존중한다는 의미에서.
하지만 그로 인해 다른 팀원이 작성한 코드를 읽는것에 어려움을 느꼈던 적은 분명 있던것이 생각이 났다.

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

• 가위 규칙(scissors rule) : 모든 인스턴스 변수를 클래스 마지막에 선언한다는 규칙. 일반적으로 C++ 에서 사용

• 소스파일은 윤곽도(outline)와 계층이 비슷하다.