클린코드 - 5.형식 맞추기

1. 형식을 맞추는 목적

코드 형식은 의사소통의 일환이다. 의사소통은 전문 개발자의 일차적인 의무!

오늘 구현한 기능이 다음 버전에서 바뀔 확률은 아주 높다

처음 잡아 놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다

---

2. 적절한 행 길이를 유지하라

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

 

소스도 신문 기사처럼 위에서 아래로 읽으며 첫 문단에 전체 기사의 내용을 요약하고

아래로 읽어 내려가면서 날짜, 이름, 발언, 주장 등 세세한 사실 알게된다

 

빈 행을 넣어 개념을 분리해야 한다

예를 들어 메서드와 메서드 사이에 빈 행이 없다면 가독성이 굉장히 떨어질 것 이다

반대로 같은 개념의 코드라면 공백 없이 밀접한 상태로 코드를 작성하는 것이 더 이해하기 좋다

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

 

하지만 실무에서는 쉽지 않을 것 같다

변수 선언 후 여러 메서드에서 재사용하는 경우도 많고, 메서드를 분리할 경우 특히.. 분리 목적 중 가장 큰 이유가 재사용이니까 말이다

---

3. 가로 형식 맞추기

들여쓰기는 매우 중요하다

뎁스 구분을 필수로 적용하자!

---

4. 팀 규칙

개발자라면 각자 선호하는 코드 규칙이 있다

하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙 이다

 

좋은 코드는 읽기 쉬운 코드이다

스타일이 통일되지 않으면 소스 코드가 필요 이상으로 복잡하게 만들어질 수 있다

 

괄호의 위치, 클래스와 변수, 메서드 명은 어떤식으로 지을지 등 협의가 필요하다

---

마무리 느낀 점

코드 컨벤션 규칙을 정하는 작업은 쉽지않은 일인 것 같긴하다

특히 문서로 정리해야하는 경우 더욱 엄두가 안날 것 같다

하지만 좋은 코드를 위해서 반드시 정의해야하는 일이기에

바쁘더라도 하루라도 빨리 정하고 코드를 컨센션에 맞춰 작성하는게 추 후 수정하는 것 보다는 쉬울 것이다

특히 네이밍의 경우 더 중요하다고 생각되는 내용이었다

당장 규칙을 정하고 문서화하는게 어렵다면 구글 컨벤션 같이 정해진 규칙을 사용하는 것도 좋은 선택이 아닐까 싶다