java code style

10명의 사람이 있다면 10개의 생각이 있다고 합니다. 마찬가지로 회사에서 일을 하다 보면 모두 코딩하는 스타일이 다릅니다. 이 때문에 다른 사람이 만든 코드를 수정하려고 보면 수정하기 어렵습니다.

이 문제를 해결하기 위해 코드 스타일 가이드가 존재합니다.

 

코드 스타일 가이드에서 말하는 코드 규칙의 중요성을 간략하게 정리하면 다음과 같습니다.

 

 

• 소프트웨어를 개발하는 일련의 모든 과정에 들어가는 비용 중 80%가 유지보수에 사용된다.
• 유지보수를 최초 소프트웨어를 개발한 사람이 담당하는 경우가 거의 없다.
• 코드 규칙을 지키면 다른 개발자가 소스코드를 보았을 때 이른 시간에 이해할 수 있도록 도와준다.

 

 

코드 스타일 가이드에는 크게 SUN의 스타일 가이드와 GOOGLE의 스타일 가이드가 있는데, 개인적으로 SUN의 가이드는 마음에 들지 않아서 GOOGLE의 가이드를 사용합니다.

GOOGLE의 가이드는 60% 정도는 SUN의 스타일 가이드와 같습니다. 가장 중요한 차이점은 SUN의 스타일 가이드는 근래에 업데이트가 안되고 있지만 GOOGLE의 가이드는 업데이트되고 있다는 것입니다.

 

intellij와 eclipse에서 GOOGLE CODE STYLE을 적용하는 방법은 다음과 같습니다.

 

IntelliJ

1. https://github.com/google/styleguide 에서 intellij-java-google-style.xml을 다운로드
2. IntelliJ에서 File > Settings 메뉴 클릭
3. Editor > Code Style 클릭
   
4. 톱니바퀴 > Import Scheme > IntelliJ IDEA code style XML 클릭
   
5. 다운받은 xml 파일 선택

 

 

Eclipse

1. https://github.com/google/styleguide에서 eclipse-java-google-style.xml을 다운로드
2. Window > Preference > Checkstyle 에서 Google Check를 기본값으로 설정하고 저장
3. 사용할 프로젝트에서 마우스 오른쪽 키 > Properties 클릭
4. 왼쪽 트리 메뉴에서 Checkstyle를 선택하고 오른쪽의 Checkstyle active for this project의 체크박스를 체크한 후 OK클릭