IT지식/노개북 Challenges

Clean Code TIL, 5장. 형식 맞추기

오선지♬ 2024. 7. 2. 22:08
728x90
반응형

오늘 TIL 3줄 요약

  • 코드가 바뀌어도 맨처음 잡아놓은 구현스타일과 가동성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
  • 500줄을 넘지않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다는 사실.
  • 가로정렬이 별로 유용하지 못하다는 사실을 깨달았다.

TIL (Today I Learned) 날짜

2024.06.30

오늘 읽은 범위

5장. 형식 맞추기

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

  • 의사소통은 전문 개발자의 일차적인 의무이다. '돌아가는 코드'가 아니라..
  • 적절한 행 길이를 유지하라.
  • 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경써서 짓는다. 소스파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마직막에는 가장 저차원함수와 세부내역이 나온다.
  • 개념은 빈 행으로 분리하라.
  • 서로 밀집한 개념은 세로로 가까이 둬야한다.
  • 변수는 사용하는 위치에 최대한 가까이 선언한다. 지역변수는 각 함수 맨 처음에 선언, 인스턴스 변수는 클래스 맨 처음에 선언
  • 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
  • 개념적인 친화도가 높을수록 코드를 가까이 배치한다.
  • 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
  • 팀은 한 가지 규칙에 합의해야 한다. 모든 팀원은 그 규칙을 따라야한다. 그래야 소프트웨어가 일관적인 스타일을 보인다. 개개인이 따로국밥처럼 맘대로 짜는 코드는 피해야 한다. 어디에 괄호를 넣을지, 들여쓰기는 몇자로 할지, 클래스와 변수와 메서드 이름은 어떻게 지을지 등을 결정했다.

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

  • 개발자의 일차적인 의무가 '돌아가는 코드'가 아니라는 것에 괜히 뜨끔해졌다.
  • 형식에 대한 설명들 중에 몇몇은 배우지 않았지만 지키고 있고, 내가 보기 편해서 글을 쓰듯이 생각하다보니 그렇게 했던 것들이 신기했다.
  • 신문기사 처럼 코드를 짜라는게 너무 이해가 잘되는 설명이었다. 상단의 함수 몇개만 읽어도 대충 흐름을 읽을 수 있는 코드를 짜도록 나도 적용해봐야겠다.
  • 인스턴수 변수를 클래스 맨 처음에 선언하는게 자바고 다른 언어는 맨 마지막에 배치한다라는 사실이 흥미로웠다.

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

  • 팀 규칙에 대한 예시가 궁금했다. 다른 회사들은 어떤 팀규칙을 가지고 일을 할까
728x90
반응형