개발자 99% 커뮤니티에서 수다 떨어요!
TIL (Today I Learned)
2022.02.28
오늘 읽은 범위
5장. 형식 맞추기
책에서 기억하고 싶은 내용을 써보세요.
형식을 맞추는 목적
코드 형식은 중요하다! (p.96)
오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.(p.96)
원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.(p.96)
신문 기사처럼 작성하라
이름은 간단하면서도 설명이 가능하게 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가방 저차원 함수와 세부 내역이 나온다. (p.98)
개념은 빈 행으로 분리하라
각 행은 수식이나 절을 나타내고, 일련의 행 무끔은 완결된 생각 하나를 표현한다. 생각 사이는 빈 행을 넣어 분리해야 마땅하다.(p.98)
세로 밀집도
서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.(p.100)
수직거리
타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다.(p.101)
세로 거리로 연관성을 표현한다. 연관성이란 한 개념을 이해하는 데 다른 개념이 중요한 정도이다. (p.101)
변수선언
변수는 사용하는 위치에 최대한 가까이 선언한다.(p.101)
루프를 제어하는 변수는 루프 문 내부에 선언한다.(p.102)
인스턴스 변수
인스턴스 변수는 클래스 맨 처음에 선언한다. (p.103)
C++에서는 모든 인스턴스 변수를 클래스 마지막에 선언한다는 소위 가위 규칙을 적용한다. (p.103)
자바에서는 클래스 맨 처음에 인스턴스 변수를 선언한다.(p.103)
잘 알려진 위치에 인스턴스 변수를 모든다는 사실이 중요하다. 변수 선언을 어디서 찾을지 모두가 알고 있어야 한다.(p.103)
종속 함수
가능하면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다.(p.104)
개념적 유사성
친화도가 높을수록 코드를 가까이 배치한다.(p.106)
한 함수가 다른 함수를 호출해 생기는 직접적인 종속성(p.106)
변수와 그 변수를 사용하는 함수(p.106)
비슷한 동작을 수행하는 일군의 함수(p.106)
세로 순서
호출되는 함수를 호출하는 함수보다 나중에 배치하면 소스 코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.(p.107)
가로 형식 맞추기
120자 정도로 행 길이를 제한한다.(p.108)
가로 공백과 밀집도
할당 연산자를 강조하려고 앞뒤에 공백을 줬다. 공백을 넣으면 두 가지 요소가 나뉜다는 사실이 더욱 분명해진다.(p.108)
함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다. 함수와 인수는 서로 밀접하기 때문이다. (p.108)
함수 괄호 안 인수는 공백으로 분리한다. 쉼표를 강조해 인수가 별개라는 사실을 보여주기 위해서다.(p.108)
가로 정렬
정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이이지 정렬 부족이 아니다. 선언부가 길다면 클래스를 쪼개야 한다는 의미다.(p.110)
가짜범위
빈 while 문이나 for 문을 피하지 못할 때는 빈 블록을 올바로 들여쓰고 괄호로 감싼다. 세미콜론은 새 행에다 제대로 들여써서 넣어준다.(p.113)
팀 규칙
좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다.(p.114)
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
105 쪽에서 잘 알려진 상수가 적절하지 않은 저차원 함수에 묻힌다. 라는 부분을 보고 특성에 맞게끔 위치 지정 하나하나 까지 중요하구나 하는 생각이 들었고 책을 보면 볼수록 그냥 돌아가게끔만 만드는게 아니라 소스를 보는 사람들이 이해하도록 구조적으로 짜는게 정말 어렵겠다는 생각이 들었다.
회사에 경력직으로 들어오셨던 분이 여기는 왜 이름 짓는 것도 중구남방이고 정해진 규칙 같은게 없냐고 물으셨던 기억이난다. 당시에 나는 낙타표기법 같은 변수명을 짓는 걸 말씀하시는 건가 그런 것도 회사 규칙이 필요한거구나 하고 지나갔었는데 이렇게 클린코드를 읽으면서 그동안 쌓인 경험들을 토대로 배우니 정말로 명명법부터 시작해서 소스를 읽고 수정하는 수 많은 회사 동료 들간에 형식 규칙이 굉장히 중요하단 걸 느낀다. 그 분도 클린코드를 보셨을까?
궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
가위 규칙(scissors rule) : Write your C++ class header so that the public part is first and the private part is last. You then take a pair of metaphoric scissors and snip off the tail end of a class header file and give the results to users of the class. Everything before the private part is what you need to use the class. This makes it a tad bit easier for readers of a class header to focus in on what they need to know about the class.
- > 가위 규칙을 사용하면 클래스 헤더의 독자가 클래스에 대해 알아야 할 사항에 집중하기 쉬워집니다.