[CS] 코딩 컨벤션

1. 코딩 컨벤션이란?

코드를 어떻게 작성할 지 규칙을 정하는 것을 말한다

탭을 할것인지 스페이스바를 할것인지 들여쓰기를 2번이냐 4번이냐

함수 뒤에 중괄호는 바로 여는가 개행 후 여는가 등의 규칙을 정해준다

 

2. 코딩 컨벤션이 필요한 이유

- 소프트웨어 개발 비용의 80%는 유지보수에 쓴다

- 소프트웨어 유지보수는 직접 개발한 개발자가 하는 경우가 적다

- 코딩 규칙을 지키면 다른 사람도 코드를 더 빨리 이해하도록 가독성이 높아진다

 

즉 같은 컨벤션을 쓰는 사람끼리는 서로 코드의 이해도가 향상되어

코드리뷰, 협업, 유지보수 하기가 더 좋아진다

 

3. JAVA의 코딩 컨벤션 종류

- NAVER : 캠퍼스 핵데이 Java 코딩 컨벤션

- Google : Google Java Style Guid

- Oracle : Code Conventions for the Java

 

4. 코딩 컨벤션 적용하기

이러한 컨벤션을 모두 기억하고 매번 맞춰가며 개발하기 쉽지 않다

그래서 코딩 컨벤션은 포맷터를 이용하여 더 쉽게 코딩 컨벤션을 적용할 수 있다

 

인텔리제이에서 포맷터를 적용 할 수 있다

 

https://github.com/naver/hackday-conventions-java/tree/master/rule-config

GitHub - naver/hackday-conventions-java: 캠퍼스 핵데이 Java 코딩 컨벤션

 

1) 위 링크에서 인텔리제이용 XML 포맷터를 다운로드 받는다

hackday-conventions-java 눌러서 메인으로 가서 다운로드 받으면 된다

2) setting -> Editor -> Code Style

 

3) Scheme 우측 톱니바퀴 -> import Scheme -> IntelliJ IDEA code style XML 클릭

 

4) 다운받은 XML 포맥터를 찾아 OK를 누르면 적용됨

 

5. 포맷터로 코드 맞추기

- 윈도우 : Ctrl + Alt + L

- 맥 : Cmd + Alt + L

 

기존에서 달라진 부분

- for와 괄호 사이 스페이스가 생김

- for 조건문에서 ;앞은 스페이스가 없어짐

- 중괄호 { } 의 위치가 K&R 방식으로 변경

 

6. 파일을 저장 할 때마다 포맷터 자동 적용하기

1) File > Settings ( Ctrl + Alt + S ) > Plugins 메뉴로 이동

 

2) Marketplace 탭에서 'Save Actions' 로 검색

 

3) Save Actions' plugin의 상세 설명 화면에서 `[Install] 버튼 클릭

 

4) IntelliJ를 재시작

 

5) File -> Settings ->  Save Actions 메뉴로 이동

 

6) 아래 항목을 체크

- Activate save actions on save

- Optimize imoprts

- Refomat file

 

7. 더 많은 정보 얻기

https://naver.github.io/hackday-conventions-java/#_intellij

캠퍼스 핵데이 Java 코딩 컨벤션