본문 바로가기

Refactoring/Simple

L.I.N.E ! (줄맞추기)

여러 사람들이 개발한 소스를 보면서 한가지 특징을 몸에 채득하고 지내고 있다. 주위 개발자들에게도 자주 이야기를 했던 내용이다.

내가 여태까지 본 개발 소스중에서 줄이 잘 맞춰져 있는 소스일 수록 코드의 퀄리티가 좋았다. 소스코드의 줄 맞추기를 하지 않고 어떤 부분은 두칸 띄우기 어떤 부분은 세칸 띄우기 어떤 부분은 1줄 비우기 어떤 부붑은 2줄 비우기 등 규칙성이 없이 짜여진 소스의 퀄리티는 대다수가 좋지 않았다.

보통 줄맞추기가 형편 없을 수록 변수명이나 로직자체도 형편 없이 진행되는 경우가 많았다. 왜일까?

소스코드를 잘 짠다는 것은 읽기 좋게 짠다는 것이다.  읽기가 좋으려면 일단 기본적으로 들여쓰기 내쓰기 줄 바꿈이 규칙적이고 일목요연하게 되어있어야 한다. 그렇지 않으면 뇌는 혼선을 가지게 된다.

상기 소스는 이상한 줄맞추기를 하고 있다.

1. 가장 위에서부터 featureJsonArr, allPathCorrdJsonArray 생성을 왜 한줄을 바꿨을까? 원래 나는 생성하면 한줄을 바꾼다고 하면 중간부분에 있는 featureJsonObj, geomtrJsonObj 는 왜 한줄 띄우질 않았나?

2. for문다음 한줄을 띄워쓰는 이유가 있나? 그렇다면 왜 if문 다음에는 2줄을 띄워썼는가? 

3. 중간부분에 들여쓰기는 왜 한번 더 들여서 썼을까? 반복, 비교문도 없는 저 위치에거 갑자기 들여쓰기를 하여 마치 반복 비교문이 위에 있는 듯한 착각을 불러일으킨다는 생각은 하지 않았을까?

4. 계속 나오는 두줄 바꾸기는 왜 나오는 걸까?

만약 바꾼다면 이렇게 바꾸는게 더 보기 좋지 않을까? 전체소스가 아니라서 그냥 줄맞추만 좀 바꾸고, 객체활용순서를 조금 연관성이 있다 싶은거끼리 바꾸었다. 

확연히 읽기 좋은 코드가 되었을 것이다.

줄맞추기 정말 중요하다. 줄만 잘 맞추어도 코드 읽기가 쉬워진다. 상기 소스의 줄맞추기는 상당히 엉터리였다. 당연히 변수나 로직도 엉터리 수준으로 개발이 되었다. 물론 기능은 돌아간다. 하지만 수정시에는 짜증이 날 것이다. 초급개발자들이 구현에만 집착하여 저런 코드를 자주 만드는데 아무래도 이 개발자는 이제 개발에 입문한 개발자 였을 것 같다.

'Refactoring > Simple' 카테고리의 다른 글

주석?!  (0) 2023.01.02