🗯️ 코드 컨벤션이란?
코드 컨벤션이란 가독성이 좋고 관리하기 쉬운 코드를 작성하기 위한 코드 스타일 규약을 말합니다
이를 준수하면 가독성을 향상시키고 오류를 발생을 야기하는 잠재적 위험요소를 줄여주어 유지보수 비용을 줄일 수 있습니다!
IntelliJ 에서는 미리 정의된 .xml 파일을 Code Style Formatter로 지정하여 단축키를 통해 지정된 컨벤션을 적용할 수 있습니다.
이로 적용하는 대표적으로 Google Java Style Guide 와 캠퍼스 핵데이 Java 코딩 컨벤션이 있습니다.
오늘은 Google Java Style Guide를 IntelliJ에 적용하는 방법을 소개하려 합니다.
자세한 컨벤션이 궁금하신 분들은 링크를 통해 확인하시기 바랍니다.
🗯️ IntelliJ용 코드 서식 다운 받기
https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml
위의 링크를 통해 intellij-java-google-style.xml 파일을 다운받습니다.
❗오른쪽 위의 Download를 클릭하시면 됩니다.
🗯️ IntelliJ에 적용하기
다음은 IntelliJ에 적용해보겠습니다.
먼저 IntelliJ를 실행합니다.
File > Settings > Code Style > Java로 들어갑니다.
(맥 기준 Preferences -> Code Style)
참고로 저는 Windows 입니다
위의 화면과 같이 세로로 나열된 점모양을 클릭 후
Import Scheme > IntelliJ IDEA code style scheme을 선택합니다.
다운 받은 intellij-java-google-style.xml 을 선택해줍니다.
🗯️ 커스텀하게 변경하기
컨벤션이 적용된 모습입니다.
하단의 메뉴들을 이용하여 세부 사항들을 커스텀하게 설정할 수 있습니다.
( Tabs and Indent, Spaces, Wrapping and Braces 등등)
보통 팀원들과 소통하며 Tab Size, Indent, Hard Wrap at(열 제한) 등을 조정합니다
🗯️ 코드 스타일 적용해보기
이제 단축키를 이용하여 코드 스타일을 적용해 봅시다!
각 단축키가 윈도우, 맥 OS별로 다릅니다.
파일 서식 지정
- Windows
Ctrl + Alt + L - Mac OS
⌥ + ⌘ + L
import문 최적화
- Windows
Ctrl + Alt + O - Mac OS
⌃ + ⌥ + O
잘못 작성된 내용이 있는 경우 댓글 언제든지 부탁드립니다!
참고 게시글
