Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
TIL-Assignment#6(5장.형식 맞추기)
#clean_code
2년 전
463

오늘 TIL 3줄 요약

  • 원래 코드는 사라질 지라도 개발자의 스타일과 규율을 사라지지 않는다.(p.96)

  • 구현한 코드의 가독성은 앞으로 바뀔 코드의 지대한 영향을 미친다.(p.96)

  • 신문 기사처럼 이름은 간단하면서도 설명이 가능하게 짓는다. (p.98)

TIL (Today I Learned) 날짜

2022. 05. 02.MON

오늘 읽은 범위

5장. 형식 맞추기

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

  • 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다. 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다. 필요하다면 규칙을 자동으로 적용하는 도구를 활용한다.(p.96)

  • 형식을 맞추는 목적 - 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드(다음 버전 등)의 품질에 지대한 영향을 미친다. 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아 놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. 원래 코드는 사라질 지라도 개발자의 스타일과 규율을 사라지지 않는다.(p.96)

  • 적절한 행 길이를 유지하라 - 자바에서 파일크기는 클래스 크기와 밀접하다. 500줄이 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.(p.97)

  • 신문 기사처럼 작성하라 - 이름은 간단하면서도 설명이 가능하게 짖는다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경써서 짓는다.(p.98)

  • 개념은 빈 행으로 분리하라.(p.98)

  • 세로 밀집도 - 서로 밀집한 코드 행은 세로로 가까이 놓여야 한다.(p.100)

  • 수직 거리 - 타당한 근거가 없다면 서로 밀집한 개념은 한 파일에 속해야 마땅하다. 이게 바로 protected 변수를 피해야 하는 이유 중 하나 이다. 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성(한 개념을 이해하는 데 다른 개념이 중요한 정도)을 표현한다.(p.101)

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

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

  • 종속 함수 - 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.(p.104)

  • 개념적 유사성 - 친화도가 높을수록 코드를 가까이 배치한다.(p.106)

  • 세로 순서 - 호출되는 함수를 호출하는 함수보다 나중에 배치한다. 그러면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다. 신문 기사와 마찬가지로 가장 중요한 개념을 가장 먼저 표현한다.(p.107

    )

  • 가로 형식 맞추기 - 공백을 넣으면 두 가지 주요 요소가 확실히 나뉜다는 사실이 분명해진다.(p.108)

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

  • 들여쓰기 - 범위로 이뤄진 계층을 표현하기 위해서 우리는 코드를 들여 쓴다.(p.111)

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

  • 내가 처음 배웠던 형식과 이 책의 형식이 비슷해서 내용이 쏙쏙 박히고, 술술 읽혔다.

  • 코드가 500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다니!! 나는 이 책을 읽기 전 나의 코드 길이는 고려하지않고 일단 실행만 잘 되기 만을 바랬다. 오늘부터는 코드의 형식을 잘 맞춰 신문처럼 읽기도 쉽고, 짧고, 이해하기도 쉽도록 클린한 코드를 만들자!

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

  • 가짜 범위?