프로그래머라면 형식을 깔끔하게 맞춰 코드를 짜야 한다.
코드 형식을 맞추기 위한 간단한 규칙을 정하고 그 규칙을 착실히 따라야 한다. 팀으로 일한다면 팀이 합의해 규칙을 정하고 모두가 그 규칙을 따라야 한다.
형식을 맞추는 목적
코드의 형식은 중요하다. 너무 중요해서 무시하기 어렵다.
하지만 융통성 없이 맹목적으로 따르면 안된다.
‘돌아가는 코드’가 전문 개발자의 일차적인 의무가 아니다. 오늘 구현한 기능이 다음 버전에서 바뀔 확률은 매우 높다. 오늘 구현한 코드 코드의 가독성은 앞으로 바뀔 코드 품질에 매우 지대한 영향을 미친다. 코드는 사라질지라도 개발자의 스타일과 규율은 사라지지 않는다.
적절한 행길이를 유지하라
소스 코드는 얼마나 길어야 적당할까?
대다수 클래스의 경우 500 줄을 넘지 않고 대부분 200줄 정도인 파일로도 커다란 시스템을 구축 할 수 있다.
반드시 지킬 엄격한 규칙은 아니지만 바람직한 규칙으로 삼으면 좋다.
일반적으로 큰 파일보다 작은 파일이 이해하기 쉽다.
신문 기사 처럼 작성하라
독자는 위에서 아래로 기사를 읽는다. 최상단에 기사를 몇 마디로 요약하는 표제가 나온다. 독자는 표제를 보고서 기사를 읽을지 말지 결정한다. 첫 문단은 전체 기사 내용을 요약한다.
소스 파일도 신문 기사와 비슷하게 작성한다. 이름은 간단하면서도 설명이 가능하게 짓는다.
이름만 보고도 올바른 모듈을 살펴보고 있는지 아닌지를 판단할 정도로 신경써서 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명한다. 아래로 내려갈수록 의도를 세세하게 묘사한다.
개념은 빈 행으로 분리하라
거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다.
각 행은 수식이나 절을 나타내고, 일련의 행 묶음은 완결된 생각 하나를 표현한다. 생각 사이에는 빈 행을 넣어 분리해야 마땅하다.
package com.jobkorea.service
import java.util.regex.*;
import com.jobkorea.model.Board;
public class BoardService {
public void save(Board board) {
...
}
public void delete(long boardId) {
...
}
}
세로 밀집도
줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다.
즉, 서로 밀집한 코드 행은 세로로 가까이 놓여야 한다는 뜻이다.
public class ReportConfig {
/**
* 리포터 리스너의 클래스 이름
*/
private String m_className;
/**
* 리포터 리스너의 속성
*/
private List<Property> m_properties = new ArrayList<Property>();
public void addProperty(Property property) {
m_properties.add(property);
}
}
위의 코드 보다는 아래 코드가 더 잘 읽힌다.
public class ReportConfig {
private String m_className;
private List<Property> m_properties = new ArrayList<Property>();
public void addProperty(Property property) {
m_properties.add(property);
}
}
수직 거리
함수 연관 관계와 동작 방식을 이해하려고 이 함수에서 저 함수로 오가며 소스 파일을 위 아래로 뒤지는 등 뺑뺑이를 돌았으나 결국은 미로 같은 코드 때문에 혼란만 가중된 경험이 있을 것이다.
함수나 변수나 정의된 코드를 찾으려 상속 관계를 줄줄이 거슬러 올라간 형험도 있을 것이다.
서로 밀접한 개념은 세로로 가까이 둬야 한다. (물론 두 개념이 서로 다른 파일에 속한다면 규칙이 통하지 않는다. 하지만 타당한 근거가 없다면 서로 밀접한 개념은 한 파일에 속해야 마땅하다. 이게 바로 protected 변수르 피해야하는 이유 중 하나다.)
연관성이 깊은 두 개념이 멀리 떨어져 있으면 코드를 읽는 사람이 소스파일과 클래스를 여기저기 뒤지게 된다.
지역 변수:
사용하는 위치에 최대한 가까이 선언한다.
인스턴스 변수:
인스턴스 변수는 클래스 맨 처음에 선언한다.
잘 설계한 클래스는 클래스의많은 메서드가 인스턴스 변수를 사용하기 때문이다.
종속 함수:
한 삼수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다. 그러면 프로그램이 자연스럽게 읽힌다. 모듈 전체의 가독성도 높아지고 호출되는 함수를 찾기도 좋아 진다.
개념적 유사성:
어떤 코드는 서로 끌어당긴다. 개념적인 친화도가 높기 때문이다. 친화도가 높을수록 코드를 가까이 배치한다.
종속 함수일 수도 있고, 개념적으로 비슷한 함수일 수 도 있고, 비슷한 동작을 하는 함수일 수도 있다.
세로 순서
일반적으로함수 호출 종속성은 아래 방향으로 유지한다.
호출 되는 함수를 호출하는 함수보다 나중에 배치한다.
가로 형식 맞추기
한 행은 가로로 얼마나 길어야할까?
대 다수가 20-60 자 사이고 80자가 넘어가는 것은 급격하게 감소한다.
옛날에는 80자 제한을 권고했지만 이것은 인위적이고 모니터가 커짐에 다라 100자나 120자에 달해도 나쁘지 않다. 그 이상은 솔직히 주의부족이다.
요즘은 모니터가 넓어지면서 200자 까지도 한 화면에 들어오지만 저자의 경우 120자가 기준이 되는 것이 바람직하다고 한다.
가로 공백과 밀집도
- 변수에 할당 연산자에는 앞 뒤로 공백을 준다.
- User user = userService.findByName(”xxxx”)
- 함수 이름과 이어지는 괄호 사이에는 공백을 주지 않는다. → 함수와 인수는 서로 밀접하기 떄문…
- public User findByName(String name) {
- 함수 호출 시 인수 사이에는 공백을 준다.
- boardRepository.save(”title”, “content”, “author”);
- 연산자 우선순위에 따라 공백을 추가하는 경우도 있다. → 하지만 툴이 대부분 지원하지 않는다.
- return bb - 4a*c;
- 사견) 개인적으로는 괄호로 표현하는게 더 직관적일 것이라 생각함. return (b * b) - (4 * a * c);
가로 정렬
아래 코드 처럼 억지로 맞추는 것은 좋지 않다. 코드가 어뚱한 부분을 강조해 진짜 의도가 가려지기 때문이다.
Strign firstName = "수열";
String lastName = "정";
String address = "서울시 강서구";
String zipcode = "15243";
Date birth = new Date(1986, 12, 18);
그냥 아래 처럼 적어도 가독성에 문제가 생기지 않는다.
정렬이 필요할 정도로 목록이 길다면 문제는 목록 일이지 정렬 부족이 아니다. 코드 선언 부분이 길다면 클래스를 쪼개야 한다는 의미다.
Strign firstName = "수열";
String lastName = "정";
String address = "서울시 강서구";
String zipcode = "15243";
Date birth = new Date(1986, 12, 18);
들여쓰기
scope 로 이뤄진 계층을 표현하기 위해 들여쓰기를 한다.
들여쓰기한 파일은 구조가 한눈에 들어온다. 변수, 생성자 함수, 메서드가 금방 보인다.
들여쓰기 무시하기
때로는 1줄 짜리 if , while , for 같은 문일 때 들여쓰기를 하지 않는 유혹에 빠질 때가 있지만 원점으러 돌아가 들여쓰기로 표현한다.
if (count < 5) { return false; }
for (int i = 0; i < count; i++) sum(value, i);
보다는..
if (count < 5) {
return false;
}
for (int i = 0; i < count; i++) {
sum(value, i);
}
가짜 범위
때로는 빈 while 문이나 for 문 을 접한다. 이런 경우를 피하지 못할 때는 빈 블록을 오바로 들여쓰고 괄호로 감싼다. 아래와 같이 while 문 끝에 세미콜론(;) 하나를 살짝 덧붙인 코드로 수없이 골탕을 먹는다. 세미콜론(;_ 은 새 행에다 제대로 들여써서 넣어준다.
while (dis.read(buf, 0, readBufferSize) != -1);
보다는
while (dis.read(buf, 0, readBufferSize) != -1)
;
팀 규칙
팀 규칙이라는 제목은 말 장난이다.
프로그래머라면 각자 선호하는 규칙이 있따. 하지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.
팀은 한가지 규ㅣㄱ에 합의해야 한다. 그리고 모든 팀원은 그 규칙을 따라야 한다. 그래야 소프트웨어가 일관적인 스타일을 보인다 .개개인이 따로국밥처럼 맘대로 짜대는 코드는 피해야 한다.
어디에 괄호를 넣을지, 들여쓰기는 몇 자로 할지, 클래스와 변수와 메서드 이름은 어떻게 지을지 등등을 결정해야 한다.
좋은 소프트웨어 시슽셈은 읽기 쉬운 ㅁ누서로 이뤄진다는 사실을 기억하기 바란다. 스타일은 일관적이고 매끄러워야 한다. 한 소스 파일에서 봤떤 형식이 다른 소스 파일에도 쓰이리라는 신뢰감을 독자에게 줘야 한다. 온갖 스타일을 뒤섞어 소스 코드르 필요 이상으로 복잡하게 만드는 실수는 반드시 피한다.
댓글 없음:
댓글 쓰기