[til] 5장. 형식 맞추기

TIL (Today I Learned) 날짜

2024년 2월 3일

오늘 읽은 범위

5장. 형식 맞추기

책에서 기억하고 싶은 내용

신문 기사처럼 작성하라

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

이름은 간단하고 설명이 가능하게 짓고, 이름만 보고도 올바른 모듈을 살펴보고 있는지를 판단할 정도로 신경 써서 짓는다.

소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명하며 아래로 내려갈수록 의도를 세세하게 묘사하여 마지막에는 가장 저차원 함수와 세부내역이 나온다.

개념은 빈 행으로 분리하라

빈 행은 새로운 개념을 시작한다는 시각적 단서다. 빈 행을 넣으면서 가독성이 좋아진다.

세로 밀집도

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

// 👎🏻
const name = "woodstock";

function func(name, skill) {
  console.log(`${name}은 ${skill}을 사용합니다.`);
};

const ts = "TypeScript";

func(name, ts);

// 👍🏻
const name = "woodstock";
const ts = "TypeScript";

function func(name, skill) {
  console.log(`${name}은 ${skill}을 사용합니다.`);
};

func(name, ts);

오늘 읽은 소감

이번 챕터에서는 코드를 신문 기사처럼 작성하라는 표현이 가장 와닿았다.

또, 그동안 Prettier나 ESLint 등 코딩 컨벤션 설정과 포맷팅을 도와주는 도구를 사용하고 있어 의식하지 못했던 형식에 대해 사용방식의 이유를 한번 더 생각해볼 수 있는 좋은 기회였다.