코딩 컨벤션이란?
코드를 어떻게 작성할 지 규칙을 정하는 것을 말한다.
탭이냐 스페이스냐, 들여쓰기에서 스페이스는 2번이냐 4번이냐, 함수 뒤에 중괄호는 바로 열 것이냐 개행 후 열 것이냐 등 규칙을 정해준다.
코딩 컨벤션이 왜 필요한가?
소프트웨어 개발 비용의 80%는 유지보수에 쓰인다.
소프트웨어 유지보수는 직접 개발한 개발자가 하는경우가 적다.
코딩 규칙을 지키면 다른 사람도 코드를 더 빠르게 이해하고 가독성이 높아진다.
->
즉 같은 컨벤션을 쓰는 사람끼리 서로 코드의 이해도가 향상된다.
따라서 코드리뷰, 협업하기, 유지보수를 하기에 더 좋다는 것같다.
가장 중요한건 가독성이 향상된다는 것!
JAVA의 코딩 컨벤션 종류
- NAVER : 캠퍼스 핵데이 Java 코딩 컨벤션
- Google : Google Java Style Guide
- Oracle : Code Conventions for the Java
더 많은 컨벤션이 있을 수 있겠지만 가장 많이 사용되는 컨벤션은 3가지 인 것 같다.
코딩 컨벤션 적용
하지만 이런 컨벤션을 모두 기억하고 매번 맞춰가며 개발하기 쉽지 않을 것이다. 이런 문제를 해결하기 위해 코딩 컨벤션은 포맷터를 이용하여 더 쉽게 코딩 컨벤션을 적용할 수 있다.
IntelliJ에서 포맷터 적용하기
IntelliJ는 XML으로 작성된 포맷터를 적용할 수 있다.
캠퍼스 핵데이 Java 코딩 컨벤션 포맷터
Google Java Style Guide 포맷터
적용 방법
1. 위 링크에서 IntelliJ용 XML 포맷터를 다운로드 받는다.
2. IntelliJ IDEA - Preferences > Editor > Code Style
3. Scheme 우측 톱니바퀴 > Import Scheme > IntelliJ IDEA code style XML 클릭
4. 다운로드 받은 XML 포맷터를 찾아 OK를 누르면 적용된다!
포맷터로 코드 맞추기
IntelliJ에서 단축키를 이용해 코드를 맞출 수 있다.
단축키 : Cmd + Alt + L
포맷터 적용 전
포맷터 적용 후(Naver 자바 컨벤션)
수정된 부분
- for와 괄호 사이 스페이스가 생김
- for 조건문에서 ;앞 빈 공간 정렬
- 중괄호({)의 위치가 K&R 방식으로 변경됨
이런 식으로 자동으로 지정한 컨벤션을 지켜 수정해준다.
아무리 뛰어난 인간이라도 집단지성을 능가할 수 없기 때문에
협업능력은 선택이 아닌 필수라는 생각이 점점 든다.
확장된 소프트웨어를 함께 다루는 개발자가 되려면 코드의 가독성을 발전시키는 방법에 대해 고민해야 한다는 생각과 함께 컨벤션의 존재를 알게 되었다. 겸손하고 성실하게 옆 사람을 도울 수 있는 사람이 되자 ㅎ
Reference
