[Clean Code] 5장. 형식 맞추기

Clean Code 5장 (형식 맞추기, 결국에는 가독성이 좋고 유지보수를 편리하게 하기 위함이다.)

같이 협업을 하기 위해서는 코드 형식을 정하고 그에 맞게 따라야 한다.

• How?
  • 적절한 행 길이를 유지하자 ( 200line을 넘지 않고 대부분의 큰 프로그램들을 만들 수 있다. 우리가 익숙한 junit, tomcat도 그렇다.)
  • 위에서 아래로 읽히듯이 (3장 참조. ) 내려가게 코딩을 하면 훨씬 가독성이 좋아진다.

코드간의 수직거리, 수평거리

• 세로 밀집도(수직거리)
  • 세로 밀집도는 연관성을 의미한다. 즉 밀접한 관계에 있는 코드들은 세로 가까이 놓여야 한다는 뜻이다.
  • 당연한 말이지만 의도적으로 기억해두어야 한다.

private String m_className;

// 아래 2줄은 연관이 있으므로 세로로 밀접하게 두었다.
private List<Property> m_properties = new ArrayList<Property>();
public void addProverty(Property property)
{
  m_properties.add(property);
}~~~~

• 가로 거리 (수평거리)
  • 한 줄에 들어가는 코드의 수는 짧은것이 좋다. 보통 20~60자로 한 행을 구성한다.

들여쓰기

• 들여쓰기를 잘 해야한다. 이건 옛날 책이라서 그런지 요즘은 IDE가 대부분 맞춰주기 때문에 지금은 고민거리가 아니게 되었다.

여기서 우리 프로젝트에 적용할점은?

• 코딩 규칙을 정하자. (우리 레포지토리에 되어있다.)
  • const는 어떻게 변수를 선언하지? 생각해보니, 우리 레포지토리 README에 이미 모두 정의되어 있었다.
  • 이전에 있을땐 모르다가, 중요성을 다시 생각하고 보니 보이게 됐다.