TIL(Today I Learned) 🧑🏻‍💻

5. 형식 맞추기

내용 정리 & 기억하고 싶은 내용

• 프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다. <p.96>

• 코드 형식은 의사소통의 일환이다. <p.96>

• 적절한 행 길이를 유지하라. <p.96>

  • 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.

  • 신문 기사처럼 작성하라 : 첫 부분에는 고차원 개념과 알고리즘을, 아래로 내려갈수록 의도를 세세하게 묘사한다. 마지막에는 가장 저차원 함수와 세부 내역이 나온다.

  • 개념은 빈 행으로 분리하라 : 생각 사이는 빈 행을 넣어 분리해야 마땅하다. 빈 행은 새로운 개념을 시작한다는 시각적 단서다.

  • 세로 밀집도 : 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.

  • 수직 거리 : 서로 밀접한 개념은 세로로 가까이 둬야 한다. 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다.

    • 변수 선언 : 변수는 사용하는 위치에 최대한 가까이 선언한다.

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

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

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

  • 세로 순서 : 일반적으로 함수 호출 종속성은 아래 방향으로 유지한다. 다시 말해, 호출되는 함수를 호출하는 함수보다 나중에 배치한다. 가장 중요한 개념을 가장 먼저 표현한다. 가장 중요한 개념을 표현할 때는 세세한 사항을 최대한 배제한다.

• 가로 형식 맞추기 : 개인적으로는 120자 정도로 행 길이를 제한한다. <P.107>

  • 가로 공백과 밀집도 : 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다. ( 할당문의 요소 구분을 위해 공백을 주고, 함수 이름과 인수로 이어지는 사이에는 공백을 넣지 않는다. )

  • 가로 정렬 : 선언문과 할당문을 별도로 정렬하지 않는다.

  • 들여쓰기 : 소스 파일은 윤곽도와 계층이 비슷하다. 계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위다.

    • 들여쓰기 무시하기 : 들여쓰기 규칙을 무시하고픈 유혹이 생기지만 들여쓰기 범위를 제대로 표현하는 코드를 선호하자.

  • 가짜 범위 : 때로는 빈 while 문이나 for 문을 접한다.

  • 팀 규칙 : 프로그래머라면 각자 선호하는 규칙이 있다. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다. 팀은 한 가지 규칙에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다.

• 좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억하기 바란다. <p.114>

생각 & 느낀점 📝

• 이번 파트는 함수파트의 연장선 처럼 느껴졌다. 사실 함수명 등의 변수명 설정과 형식 맞추기는 뗄 수 없는 관계라고 느껴진다. 둘 중 하나라도 부족하게 느껴진다면 코드는 이상하게 보일 것이다.

• 세로형식과 가로형식 부분은 상당히 도움이 되었다. 유사한 개념을 밀접하게 두고 사용하는 위치에 최대한 가까이 변수 선언을 하는 것과 같은 법칙들은 코드를 하나의 이야기처럼 읽을 수 있도록 만들어주는 가장 중요한 법칙이라고 생각했다.

• 형식을 맞추는것은 코드를 하나의 글 처럼 읽을 수 있게 하는 방법이다.

새로 용어 정리

• 가위 규칙(scis-sors rule) : 일반적으로 C++에서 모든 인스턴스 변수를 클래스 마지막에 선언한다는 규칙

참고 문헌