이클립스 소스 코드 스타일 및 유용한 팁 몇 가지

이번 시간에는 앞서 말했던 소스 코드 스타일을 통일시키고 좀더 나은 가독성을 위한 튜닝(?)을 소개해볼까 합니다.

보통 프로그램 개발에 신입으로 들어가게 되면 여러 개발에 관련된 획일화된 작업을 배우게 됩니다. 이것은 작업의 능률과 통일성을 갖기 위한 필요 조건이라 볼 수 있겠지요?

하지만.. 나만의 코드 스타일을 고집하겠다!!( 음.. 선배님과의 파이팅 날을 잡으시길…) 획일화된 코드 스타일을 꼭 강요하지 않는 곳도 많지만 여러 소스를 분석하거나 작업을 하다 보면 확실히 통일된 소스코드가 주는 가독성은 무시할 수 없더군요.

저 역시 처음 입사했을 당시 이렇다 할 코드스타일이라든지 기타 통일된 업무를 받지 못한 터라 오히려 제가 불편해서 부장님의 스타일에 맞게 고치려고 노력했었죠.

 

각설하고 이클립스에서 소스 코드 스타일을 획일화 시키는 방법을 알아보겠습니다.

환경설정 -> Java -> Code Style -> Formatter에 가시면 다음과 같은 코드 스타일을 보실 수 있습니다.

그러면 수정을 해보러 가실까요?

수정할 수 있는 항복들은 무지무지 많습니다. 띄어쓰기 중괄호 내리기 올리기 인자 값 표현 등등..

처음으로 보실 항목은 들여쓰기 부분입니다. 들여쓰기 시 공백은 4칸으로 지정을 하였으며 변수를 정의할 때 각각을 가독성을 위한 정렬을 사용하였습니다.

Indent 부분은 본문, enum, method 등등 들여쓰기를 할 것인지를 체크하는 항목입니다. 체크를 해제를 하면 어떻게 될까요? 그림부터 보고 가실께요!

확연하게 아시겠죠? 설정은 그냥 클릭 몇 번으로 금방 하실 수 있으며 오른쪽에서 적용된 모습을 바로 확인이 가능하기 때문에 들여쓰기 부분은 금방 설정하실 수 있을 겁니다.

그렇다면 다음 설정 탭은 중괄호 설정입니다. 이클립스 기본 설정은 중괄호를 여는 부분은 같은 라인에 정의되어 있습니다. 하지만 저는 모든 중괄호는 내리고 닫는 부분이 한 라인을 차지하도록 설정하였습니다. (부장님의 스타일..)

 

다음으로 보실 부분은 공백 처리 입니다. 각각의 항목은 선언부분, 함수 스타일, 배열, parameter 타입이 있습니다. 이 부분은 쉼표 뒤에 띄어쓰기를 설정하고 나머지는 거의 건들이지 않았습니다.

 

다음으로 보실 내용은 Blank Lines 간단히 말해 함수 변수 등등을 선언하고 각각의 공백라인을 얼마만큼 줄 것인가를 설정하는 부분입니다.

 

다음은 새로운 라인에서 시작할지 여부를 설정하는 탭입니다. 배열을 선언할 때 중괄호를 열고 배열을 지정하고 중괄호를 닫고 할 때 중괄호를 열고 다음 줄에 배열을 정의하고 다음 줄에 중괄호를 닫고 이런 형태입니다.

배열뿐만 아니라 함수, 메소드 등등 설정할 수 있습니다.

 

함수 설정 부분입니다. do, while문이라든지 if문이라든지 중괄호를 닫을 때 붙여 쓸지 말지 설정할 수 있습니다.

 

한 화면에 표현할 최대 글자 수와 이를 넘어갈 경우 자동으로 다음 라인으로 넘길지 설정하는 부분입니다. 일반적으로 소스를 작성할 경우 해당 설정은 적용되지 않지만 소스 코드를 다 작성 후 해당 포맷으로 변경을 하게 되면 여기에서 설정한 형태로 바뀌게 됩니다.

 

코멘트를 달 때 코멘트 포맷을 지정할 수 있습니다.

 

끝으로 Off / On tag 부분인데 저는 아직 한번도 사용하지 않은 기능이라 기본상태입니다.

 

이렇게 적고 보니 소스코드의 작은 부분 하나까지 설정을 할 수 있는 것을 보실 수 있습니다. 그리고 모든 설정을 다 하고 설정을 적용한 뒤 팀원들과 함께 사용하기 위해서 Export로 해당 포맷을 공유하는 것도 좋은 방법이겠죠?

그리고 추가로 알려드릴 몇 가지 팁! 폰트 및 색상을 설정할 수 있는 부분입니다. 누구나가 다 아시는 부분이겠지만.. 그냥 한번 더 확인해 보시라는 입장에서.. 이런 저런 폰트를 다 사용해봤지만 Consolas 폰트가 코드로 볼 때 가장 눈에 잘 들어와서 폰트도 큼지막하게 13!(이라고는하지만 더 작으면 잘 안보여서..)

 

다음은 단축키 설정부분입니다!! 이 부분도 윈도우에서 이클립스를 사용 할 경우 컨트롤 + 스페이스를 누르면 Content Assist가 활성이 되어 긴~~ 변수나 함수 명을 일일이 다 칠 필요 없이 선택할 수 있었는데 Mac에서는 자꾸만 Spotlight 검색 기능이 뜨는 바람에 설정을 조금 바꾸어 주었습니다.

Content Assist로 검색하셔서 해당부분을 원하는 키로 바꿔서 사용하시면 유용할 것 같네요~ 저는 control + command + space 키를 사용하고 있습니다.

 

마지막으로 알려드릴 팁은 Code Templates입니다. 간단히 말해 내가 작성하고자 하는 함수가 어떻게 동작할 지 인자로는 어떤 것을 받고 무엇을 반환할지를 자세하게 적는 부분이라 보시면 되겠습니다. 이렇게 함수나 메소드 등에 자세히 적어놓으면 한참 뒤에 내 소스를 다시 들여다 봤을 때 이게 무슨 기능이었지? 어떻게 동작했지? 뭘 반환했지? 라고 고민하고 기억을 더듬어 가는 시간을 확연하게 줄일 수 있으리라 생각됩니다.

 

오늘의 포스팅은 여기서까지!! 헉헉 그림이 많아서 더 힘들었던 것 같네요.. 그래도 이런저런 실행착오를 겪으며 이게 좋았지~ 저게 좋았지~ 하고 생각나는 부분을 기록하고 공유할 수 있으면 좋을 것 같아서 적어봅니다.

오늘도 어김없이 코딩 코딩 코딩 하세요~~