TIL 05. 형식 맞추기

오늘 TIL 3줄 요약

  • 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다. (114p)
  • 형식을 맞추는 목적이 중요하다. 그 목적엔 ‘돌아가는 코드’ 가 일차적인 의무가 아니다. 돌아가는 코드라는 생각을 내려두자. (96p)
  • 좋은 신문 기사를 작성하듯 코드를 작성하자. 전달력 좋은 글을 쓰듯 코드를 작성한다. (98p)

TIL (Today I Learned) 날짜

2022.05.02

오늘 읽은 범위

5장. 형식 맞추기

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

  • 좋은 신문 기사를 작성하듯(98p)이라는 소단원의 내용에 5장의 내용이 모두 내포되어 있다. 읽기 좋은 글의 특성을 추려보면 5장 내용들과 일맥상통할 것이다. 그 중 대표적이라 생각하는 요소들을 쓰자면 아래와 같다.

    • 98p ~ 101p 의 내용 요약

    1. 개념은 상단 요약 (초반에 요약)

    2. 개념에서 쓰는 변수 선언은 쓰는 개념과 가깝게 선언. ( 연관된 종속 메소드의 선언도 동일 )

  • 저자와 완전히 동일한 의견을 갖고 있는 부분이 있었다. 들여쓰기 무시하기(112p ~ 113p)의 내용이다. 간단한 if 문, 짧은 while 문 코드의 경우 일부 사람들은 들여쓰기나 괄호 표기를 무시하고 한 줄로 짤막하게 표현하는 경우가 있다. 볼 때마다 눈이 찡그려진다. 프로그램이 정상적으로 작동하는데 문제가 있는 코드는 아니다. 하지만 해당 코드를 유지보수하는 입장이 되어 고친 경험상, 눈에 확 들어오질 않았었다. 단순한 경우라도 범위를 빠르게 구분 짓기 위해, 들여쓰기와 괄호까지 제대로 표현한 코드로 수정했었다. 경험상 그렇게 표기한 사람들은 행으로 개념 구분하는 부분에서도 빈약해 행 넣는 작업까지 한 경험이 있다.

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

  • 읽기 좋은 코드 = 좋은 글 이라는 생각을 하게 했던 경험들을 떠오르게 한 파트였다. 왜 좋은 글처럼 써야하는가? 시간 효율성에도 연관 있다는 것 만으로 충분한 이유가 된다 생각한다. 단순한 사항들이지만 이를 지킨 것과 안 지킨 것은 나중에 유지보수할 때 입장에선 천지차이가 난다. 파일을 열자마자 눈쌀이 찌푸려지는 경험을 해 봤다면 이 단순한 사항들이 얼마나 많은 영향을 가질 지 알 것이다.