클린코드 : 형식 맞추기

 

 

형식 맞추기

 

형식을 맞추는 목적

- 가독성을 위해서

 

적절한 행 길이를 유지하라

 

신문기사처럼 작성하라

- 이름은 간단하고 알기 쉽게 

- 아래로 내려갈수록 세세하게 

 

개념은 빈 행으로 분리하라

- 메서드 간 행 띄우기 

 

세로 밀집도

- 서로 밀접한 코드 행은 세로로 가까이 놓여야한다 

// 의미 없는 주석을 제거함으로써 코드가 한눈에 들어온다.
// 변수 2개에 메소드가 1개인 클래스라는 사실이 드러난다.

public class ReporterConfig {
	private String m_className;
	private List<Property> m_properties = new ArrayList<Property>();
	
	public void addProperty(Property property) { 
		m_properties.add(property);
	}

 

수직 거리

- 변수 선언 : 사용 위치에 최대한 가까이 선언하기 

- 인스턴스 변수 : 클래스 맨 첨에 선언 

- 종속 함수 : 함수가 다른 함수 호출하는 경우 그 함수는 호출 함수 근처에 있어야함 

- 개념적 유사성 : 비슷하고 친화도가 비슷한 함수끼리 위치를 가까이 배치

 

세로 순서

- 함수 호출 종속성은 아래 방향으로 유지 즉 위에서 아래로 배치함으로서 고차원에서 저차원으로 자연스럽게 내려감 

 

가로 형식 맞추기 

- 최대한 짧게 

- 저자는 120자 정도로 제한 

 

팀 규칙

- 서로 합의하에 정한 규칙을 준수하고 개인적인 선호는 넣지 않는다

 

참고

 

https://product.kyobobook.co.kr/detail/S000001032980

Clean Code(클린 코드) | 로버트 C. 마틴 - 교보문고