TIL (Today I Learned)
2024.03.09
🔖 오늘 읽은 범위
5장. 형식 맞추기
💡 책에서 기억하고 싶은 내용
"프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야한다."
코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다.
팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다.
필요하다면 규칙을 자동으로 적용하는 도구를 활용한다.
형식을 맞추는 목적
코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무다.
오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도
맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다.
원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.
적절한 행 길이를 유지하라
500줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.
반드시 지킬 엄격한 규칙은 아니지만 바람직한 규칙으로 삼으면 좋겠다.
일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
신문 기사처럼 작성하라
이름은 간단하면서도 설명이 가능하게 짓는다.
이름만 보면서도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경 써서 짓는다.
소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.
신문이 사실, 날짜, 이름 등을 무작위로 뒤섞은 긴 기사 하나만 싣는다면 아무도 읽지 않으리라.
개념은 빈 행으로 분리하라
빈 행은 새로운 개념을 시작한다는 시각적 단서다.
빈 행을 빼버린 코드는 가독성이 현저하게 떨어져 암호처럼 보인다.
세로 밀집도
줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.
즉, 서로 밀접한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.
수직 거리
함수 연관 관계와 동작 방식을 이해하려고 이 함수에서 저 함수로 오가며 소스 파일을 위아래로 뒤지는 등 뺑뺑이를 돌았으나 결국은 미로 같은 코드 때문에 혼란만 가중된 경험이 있는가?
함수나 변수가 정의된 코드를 찾으려 상속 관계를 줄줄이 거슬러 올라간 경험이 있는가?
시스템이 무엇을 하는지 이해하고 싶은데, 이 조각 저 조각이 어디에 있는지 찾고 기억하느라 시간과 노력을 소모한다.
서로 밀접한 개념은 세로로 가까이 둬야 한다.
타당한 근거가 없다면 서로 밀집한 개념은 한 파일에 속해야 마땅하다.
이게 바로 protected 변수를 피해야 하는 이유 중 하나다.
같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.
연관성이란? 한 개념을 이해하는 데 다른 개념이 중요한 정도
연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다.
변수 선언
변수는 사용하는 위치에 최대한 가까이 선언한다.
짧은 함수의 지역 변수는 각 함수 맨 처음에 선언한다.
인스턴스 변수
인스턴스 변수는 클래스 맨 처음에 선언한다.
변수 간에 세로로 거리를 두지 않는다.
잘 설계한 클래스는 많은 클래스 메서드가 인스턴스 변수를 사용하기 때문이다.
변수 선언을 어디서 찾을지 모두가 알고 있어야 한다.
종속 함수
한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
호출하는 함수를 호출되는 함수보다 먼저 배치한다.
호출하는 함수를 찾기가 쉬우면 모듈 전체의 가독성도 높아진다.
개념 유사성
어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다. 친화도가 높을수록 코드를 가까이 배치한다.
친화도가 높은 요인
- 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성
- 변수와 그 변수를 사용하는 함수
- 명명법이 똑같고 기본 기능이 유사한 함수들
- 서로가 서로를 호출하는 관계는 부차적인 요인
세로 순서
일반적으로 함수 호출 종속성은 아래 방향으로 유지한다.
호출되는 함수를 호출하는 함수보다 나중에 배치한다.
그러면 소스코드 모듈이 고차원에서 저차원으로 자연스럽게 내려간다.
가로 형식 맞추기
한 행은 가로로 얼마나 길어야 적당할까?
프로그래머는 명백하게 짧은 행을 선호한다. 그러므로 짧은 행이 바람직하다.
개인적으로는 120자 정도로 행 길이를 제한한다.
가로 공백과 밀집도
가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않았다.
함수와 인수는 서로 밀접하기 때문이다.
(공백을 넣으면 한 개념이 아니라 별개로 보임)
함수를 호출하는 코드에서 괄호 안 인수는 공백으로 분리했다.
쉼표를 강조해 인수가 별개라는 사실을 보여주기 위해서다.
연산자 우선순위를 강조하기 위해서도 공백을 사용한다. 수식을 읽기가 아주 편하다.
승수 사이는 공백이 없다. 곱셈은 우선 순위가 가장 높기 때문이다.
항 사이에는 공백이 들어간다. 덧셈과 뺄셈은 우선순위가 곱셈보다 낮기 때문이다.
가로 정렬
가로 정렬이 별로 유용하지 못하다는 사실을 깨달았다.
코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문이다.
정렬하지 않으면 오히려 중대한 결함을 찾기 쉽다.
정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이지 정렬 부족이 아니다.
선언부가 길다면 클래스를 쪼개야 한다는 의미다.
들여쓰기
범위로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.
들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.
- 클래스 정의처럼 파일 수준인 문장은 들여쓰지 않는다.
- 클래스 내 메서드는 클래스보다 한 수준 들여쓴다.
- 메서드 코드는 메서드 선언보다 한 수준 들여쓴다.
- 블록 코드는 블록을 포함하는 코드보다 한 수준 들여쓴다.
들여쓰기가 없다면 인간이 코드를 읽기란 거의 불가능하리라.
들여쓰기한 파일은 구조가 한눈에 들어온다.
반면, 들여쓰기 하지 않은 코드는 열심히 분석하지 않는 한 거의 불가해하다.
들여쓰기 무시하기.
한 행에 범위를 뭉뚱그린 코드를 피한다.
가짜 범위
빈 while문이나 for문을 피하지 못할 때는 빈 블록을 올바로 들여쓰고 괄호로 감싼다.
지금까지 나는 while문 끝에 세미콜론(;) 하나를 살짝 덧붙인 코드로 수없이 골탕을 먹었다.
세미콜론(;)은 새 행에다 제대로 들여써서 넣어준다. 그렇게 하지 않으면 눈에 띄지 않는다.while (dis.read(buf, 0, readBufferSize) != -1) ;
팀 규칙
프로그래머라면 각자 선호하는 규칙이 있다.
하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다.
그래야 소프트웨어가 일관적인 스타일을 보인다. 개개인이 따로국밥처럼 맘대로 짜대는 코드는 피해야 한다.
좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다.
스타일은 일관적이고 매끄러워야 한다.
한 소스 파일에서 봤던 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야한다.
온갖 스타일을 뒤섞어 소스 코드를 필요 이상으로 복잡하게 만드는 실수는 반드시 피한다.
밥 아저씨의 형식 규칙
코드 자체가 최고의 구현 표준 문서가 되는 예다. - p.114 참고
✏️ 오늘 읽은 소감
형식 맞추기는 앞에서 읽었던 깨끗한 코드, 이름 짓기, 주석에 비해서는 덜 고민을 했던 부분인 것 같다.
왜 그런가? 생각해봤는데 내 눈에 보기 편하게 시각적으로 표현하는 습관이 반영되어 있었던 것 같으면서도
'처음에 그렇게 배웠으니까? 무의식적으로 지키고 있다는 걸 수도 있겠다..' 는 생각이 들기도 했다.
옛날에는 답이었지만 지금은 답이 아닐 수도 있다는 김영한 강사님이 했던 말씀이 생각나기도 했었다.
스스로에게 항상 왜?라는 의문점을 가지고 접근을 하도록 노력해야겠다.
그래도 코드를 짤 때마다 빈 행의 기준이 애매했는데 이번 내용을 읽고 물음표에서 느낌표로 바뀌기도 하였다.
마지막에는 밥 아저씨의 형식 규칙을 소개하면서 턴을 종료하는데 내가 곧 합류하게 될 회사의 개발팀 컨벤션은 과연 어떻게 될 지도 궁금하다 🙋♀️
앞으로는 빈 행을 더 의미있게 쓰고, 규칙을 일관적으로 적용해서 예측 가능한 코드를 짜야겠다는 생각이 들었다. 언젠가 이 조각 저 조각이 어디에 있는지 찾고 기억하느라 시간과 노력을 소모하는 일이 줄어들겠지..?
🤔 궁금한 내용이나 잘 이해되지 않는 내용
종속 함수의 상수를 적절한 수준에 두는 예제 - p.105
