TIL #06 형식 맞추기

2022. 5. 1. 16:16

오늘 TIL 3줄 요약

오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 미친다.

오랜 시간 지나 코드가 많이 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확상성에 계속 영향을 미친다.

신문 기사처럼 작성하기
이름은 간단하면서도 설명이 가능하게 짓는다. 소스 파일의 첫 부분은 고차원 개념과 알고리즘을 설명한다. 내려갈수로록 의도를 세세하게 묘사한다.
개념은 빈 행으로 분리
패키지 선언부, import 문, 각 함수 사이에 빈행을 넣는다. 빈 행은 새로운 개념을 시작한다는 시각적 단서이다.
세로 밀집도
세로 밀집도는 연관성을 의미한다. 서로 밀접한 코드 행은 세로로 가까이 놓아야 한다.
수직 거리
서로 밀접한 개념은 세로로 가까이 두어야 한다.
변수 선언는 사용하는 위치에 최대한 가까이 선언한다.
인스턴스 변수는 클래스 맨 처음에 선언한다.
종속 함수는 한 함수가 다른 함수를 호출하면 세로로 가까이 배치하고, 호출하는 함수를 먼저 배치한다.
개념적 유사성이 높은 함수는 서로 가까이 배치한다.
세로 순서
함수 호출 종속성은 아래 방향으로 유지한다.

가로 공백과 밀집도
할당 연산자를 강조하기 위해 함뒤에 공백을 추가하였고, 함수 이름과 이어지는 괄호 사이에는 공백을 넣지 않아 함수와 인수는 밀접함을 나타낸다. 괄호 안 인수는 공백으로 분리하여 별개라는 사실을 보여준다.

int lineSize = line.length();
lineWidthHistogram.addLine(lineSize, linCount);

가로 정렬
아래 예시와 같은 가로 정렬은 변수 유형은 무시하고 변수 이름부터 읽히게 된다. 코드가 엉뚱한 부분을 강조해 진짜 의도가 가려지기 때문에 가로 정렬은 하지 않는다.
정렬이 필요할 정도로 목록이 길다면 문제는 목록의 길이지 정렬 부족이 아니다.

private	Socket		socket;
private	InputStream	input;
private	OutputStream	output;

들여쓰기
들여쓰기한 파일은 구조가 한눈에 들어온다.
때로는 간단한 if문, while문, 짧은 함수에서 들여쓰기 규칙을 무시하고픈 유혹이 생기지만 들여쓰기를 하자.
가짜 범위
빈 while문이나 for문일 때에는 새 행에 세미콜론(;)을 들여써 넣어주자.

나는 그 동안 일관된 형식이나 규칙을 가지고 코드를 작성해본 적이 없다. 다만 그때 그때 보고 적당해 보이는 형태로 작성을 하였다. 그래서 나중에 다시 코드를 찾아볼 때에는 무슨 내용이었는지 한참 들여다 보는 경우가 있었다. 이런 디테일한 부분에서도 가독성을 높일 수 있다는 것을 깨닫게 된다. 오늘부터 형식에 유념하여 코드를 작성하여 보아야겠다.