Clean Code 5 장형식 맞추기

2012 02. 03원종필

왜 ? 형식을 맞추나 ?

코드 형식은 의사소통의 일환이다

시간이 지나 코드의 흔적을더이상 찾아보기 어려울 정도로 코드가 바뀌어도 개발자의 스타일과 규율은사라지지 않는다 .

적절한 행 길이

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

개념은 빈행으로 분리하라

일련의 행 묶음은 완결된 생각하나를 표현한다 .생각 사이는 빈 행을 넣어서 분리해야 마땅하다

종속함수

프로그램이 자연스럽게 읽힐수 있게 함수를 배치하면 모듈 전체의 가독성도 높아진다 .

public void Make() {String name = GetName();if(name != null)

SendName(name);else

PrintError();}

public String GetName() {

}public void SendName() {

}public void PrintError() {

가로 정렬

코드가 엉쭝한 부분을 강조해 진짜 의도가 가려진다변수유형을 무시하고 변수 이름부터 읽게 된다 .

private Socket socket;private InputStream input;private OutputStream output;protected FitNesseContext context;

private Socket socket;private InputStream input;private OutputStream output;protected FitNesseContext context;

정렬이 필요할 정도로 목록이 길다면 문제는 목록길이지 정렬부족이 아니다 !

형식 ...

변수는 사용하는 위치에 최대한 가까이 선언한다 .인스턴스 변수는 잘 알려진 위치에 모은다 .비슷한 동작을 수행하는 함수들은 가까이 배치한다 .함수 호출 종속성을 아래 방향으로 유지한다 .들여쓰기를 사용하여 코드 구조가 한눈에 들어오게 한다 .....

팀에 속해서 프로그래밍을 한다면 ,팀이 정한 규칙을 따라야 한다 .그래야 소프트웨어가 일관적인 스타일을 보인다 .

가장 중요한것 .

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다 .

Q/A

END