형식 맞추기

[클린 코드] 형식 맞추기(2)

수직거리 서로 밀접한 개념은 세로로 가까이 두어야 한다. 같은 파일에 속할 정도로 밀접한 두 개념은 세로 거리로 연관성을 표현한다. 여기서 말하는 연관성이란 한 개념을 이해하는데 다른 개념이 더 중요한 정도이다. 연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스 파일과 클래스를 여기저기 뒤지게 된다. 변수 선언 변수는 사용하는 위치에 최대한 가까이 위치해야 한다 만들어낸 함수가 매우 짧을경우 지역 변수는 각 함수 맨 처음에 선언하는 것도 하나의 방법이겠다. 아래 코드는 JUnit 4.3.1에서 가져온 다소 긴 함수이다. private static void readPreferences(){ InputStream is = null; try{ is = new FileInputStream(g..

[클린 코드] 형식 맞추기(1)

프로그래머는 형식을 깔끔하게 맞춰 코드를 작성해야 한다. 코드 형식을 맞추기 위한 간단한 규칙을 정하고, 그 규칙을 따라야 한다. 팀으로 일한다면 팀이 합의하여 규칙을 정하고 모두가 그 규칙을 따라야 한다. 가능하다면 규칙을 자동으로 적용하는 도구를 사용하면 더욱 편해진다. 형식을 맞추는 목적 코드 형식은 의사소통의 일환이다. 또한 의사소통은 전문 개발자의 1차적인 의무이다. 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 매우 높다. 하지만 오늘 구현한 코드의 가독성은 앞으로 바뀔 코드의 품질에 지대한 영향을 줄 수 있다. 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성과 확장성에 계속 영향을 미친다. 그..