Community

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

← Go back
TIL 5장 형식 맞추기
#clean_code
2년 전
425

오늘 TIL 3줄 요약

  • 형식 맞추기의 목적은 의사소통의 일환이다. 맨 처음 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 영향을 준다.

  • 신문 기사와 비슷하게 작성한다. 가중 중요한 개념을 가장 먼저 표현한다. 가장 중요한 개념을 표현할 때 세세한 사항은 최대한 배제한다.

  • 스타일은 일관적이고 매끄러워야 한다. 온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피한다.

TIL (Today I Learned) 날짜

2022. 05. 02

오늘 읽은 범위

5장. 형식 맞추기

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

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

  • 소스 파일도 신문 기사와 비슷하게 작성한다. 이름은 간단하면서도 설명이 가능하게 짓느다. 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다. (p.98)

  • 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다. (p.100)

  • 변수는 사용하는 위치에 최대한 가까이 선언한다. 우리가 만든 함수는 매우 짧으므로 지역 변수는 각 함수 맨 처음에 선언한다. (p.101)

  • 종속함수. 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. (p.104)

  • 개념적 유사성. 어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다. 친화도가 높을수록 코드를 가까이 배치한다. (p.106)

  • 할당 연산자를 강조할 때 앞뒤에 공백을 준다. (예시: a = b)

  • 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다. (예시: addLine(lineSize, lineCount);)

  • 승수 사이에는 공백이 없다. (예시: b*b - 4*a*c)

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

  • 종속함수를 사용할 때 함수 배치를 어떻게 할지 고민을 많이 했었는데 앞으로 코드를 수정하거나 작성할 때 호출되는 함수를 나중에 배치하도록 해야겠다.

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

  • 클래스에 대한 개념이 제대로 안잡혀서 인스턴스 변수라는 것을 다시 공부해 봐야할 것 같다.