진소희

1. 📌 핵심 개념 정리

✅ 요약하기

형식에 맞추는 목적
- 코드 형식은 의사소통의 일환이기 때문에 중요하다.
- 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 매우 높다.
- 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.
- 원래 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.

적절한 행 길이를 유지하라
- 세로길이(지금은 파일 크기만 고려)
  - 500줄을 넘지 않고 200줄 정도인 파일로도 커다란 시스템을 구축할 수 있다.
  - 일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
- 신문 기사처럼 작성하라
  - 최상단에 표제가 나온다. 독자는 표제를 보고서 기사를 읽을지 말지 결정한다. 첫 문단은 전체 기사 내용을 요약한다. 세세한 사실은 남기고 커다란 그림을 보여준다. 쭉 읽으며 내려가면 세세한 사실이 조금씩 드러난다.
  - 소스파일도 비슷하게 작성한다. 이름은 간단하면서도 설명이 가능하게, 이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단되도록 짓는다.
  - 소스파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사하고, 마지막에는 가장 저차원 함수와 세부내역이 나온다.
- 개념은 빈 행으로 분리하라
  - 빈 행은 새로운 개념을 시작한다는 시각적 단서다. 빈 행이 없이 코드를 짜게 되면 코드 가독성이 현저히 떨어진다.
- 세로 밀집도
  - 줄바꿈이 개념을 분리한다면, 세로 밀집도는 연관성을 의미한다.
  - 서로 밀접한 코드 행은 세로로 가까이 놓아야 한다.
- 수직 거리
  - 서로 밀접한 개념은 세로로 둬야 한다는 것은 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다. 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다.
  - protected 변수를 피해야 하는 이유 중 하나.
- 변수 선언
  - 변수는 사용하는 위치에 최대한 가까이 선언한다.
  - 루프를 제어하는 변수는 흔히 루프문 내부에 선언한다.
  - 드물지만 다소 긴 함수에서 블록 상단이나 루프 직전에 변수를 선언하는 사례도 있다.
- 인스턴스 변수
  - 반면, 인스턴스 변수는 클래스 맨 처음에 선언한다.
  - 변수 간에 세로로 거리를 두지 않는다. 잘 설계한 클래스는 클래스의 많은 메서드가 인스턴스 변수를 사용하기 때문이다.
  - 잘 알려진 위치에 인스턴스 변수를 모은다는 사실이 중요하다
- 종속함수
  - 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다.
  - 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.
  - 규칙을 일관적으로 적용한다면 독자는 방금 호출한 함수가 잠시 후에 정의되리라는 사실을 예측한다.
  - 상수를 알아야 마땅한 함수에서 실제로 사용하는 함수로 상수를 넘겨주는 방법이 좋다.
- 개념적 유사성
  - 친화도가 높을 수록 코드를 가까이 배치한다.
  - 친화도가 높은 요인은 여러가지이다.
    - 한 함수가 다른 함수를 호출해 생기는 직접적인 종속성이 한 예이다.
    - 변수와 그 변수를 사용하는 함수도 한 예이다.
    - 비슷한 동작을 수행하는 일군의 함수가 좋은 예이다.
```
 public class Assert {
   static public void assertTrue(String message, boolean condition) {
     if (!condition)
       fail(message);
   }
   static public void assertTrue(boolean condition) {
     assertTrue (null, condition);
   }
   static public void assertFalse(String message, boolean condition) {
     assertTrue message, ! condition);
   }
   static public void assertFalse(boolean condition) {
     assertFalse (null, condition);
   }
```
    - 이 함수들은 개념적인 친화도가 매우 높다. 명명법이 똑같고 기본 기능이 유사하고 간단하다. 서로가 서로를 호출하는 관계는 부차적인 요인이다. 종속적인 관계가 없더라도 가까이 배치할 함수들이다.

가로 형식 맞추기
- 한 행은 가로로 얼마나 길어야 적당할까?
  - 7개정도의 프로젝트에서 조사한 행 길이 분포는 45자 근처에서 규칙적이었다.
  - 짧은 행이 바람직하다.
- 가로 공백과 밀집도
  - 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.
  - 할당 연산자를 강조하려고 앞뒤에 공백을 준다
  - int lineSize = line.length();
  - 이러면 두 가지 주요 요소가 확실히 나뉜다.
  - 반면에, 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않는다. 함수와 인수는 서로 밀접하기 때문이다. 공백을 넣으면 한 개념이 아니라 별개로 보인다.
  - lineWidthHistogram.addLine(lineSize, lineCount)
  - 함수 호출 코드에서 괄호 안 인수는 공백으로 분리한다. 쉼표를 강조해 인수가 별개라는 사실을 보여주기 위해서이다.
  - b*b - 4*a*c
  - 연산자 우선순위를 강조하기 위해서도 공백을 사용한다.
- 가로 정렬
  - 특정 구조를 강조하고자 하는 가로정렬은 별로 유용하지 못하다.
  - 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문이다.
  - 정렬이 필요할 정도로 목록이 길다면 문제는 목록 길이이지 정렬 부족이 아니다. 즉, 선언부가 길다면 클래스를 쪼개야 한다는 의미이다.
- 들여쓰기
  - 계층에서 각 수준은 이름을 선언하는 범위이자 선언문과 실행문을 해석하는 범위이다.
  - 범위로 이뤄진 계층을 표현하기 위해 우리는 코드를 들여쓴다.
  - 들여쓰는 정도는 계층에서 코드가 자리잡은 수준에 비례한다.
- 들여쓰기 무시하기
  - 때로는 간단한 if문, while문, 짧은 함수에서 들여쓰기 규칙을 무시하고픈 유혹이 생길지라도 항상 원점으로 돌아가 들여쓰기를 해야 한다.
- 가짜 범위
  - 때로는 빈 while문이나 for문을 접한다. 가능한 한 피하는 게 좋지만 피하지 못할 때는 빈 블록을 올바로 들여쓰고 괄호로 감싼다.
  - 세미콜론은 새 행에다 제대로 들여써서 넣어준다.
```
while (dis.read(buf, 0, readBufferSize) != -1)
;
```

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

상수를 알아야 마땅한 함수에서 실제로 사용하는 함수로 상수를 넘겨주는 방법이 좋다???

2. 📚 참고 사항

📢 논의하기

관련 자료 공유
- 추가 자료
  - 가위 규칙

코드의 맨 위에 public 메서드/인터페이스 메서드가 있고 맨 아래에 private 메서드가 있는 방식으로 코드를 스타일링

논의하고 싶은 주제
- 주제
  - 친화도가 높은 요인이 더 어떤 것들이 있을까?
- 설명
  - 음
- 주제
  - 때로는 빈 while문이나 for문을 접한다. 피하지 못할 때는 어떤 때일까?
- 설명
  - 음

진소희

1. 📌 핵심 개념 정리

✅ 요약하기

2. 📚 참고 사항

📢 논의하기

설명

설명