👀 배경 설명
- 프리코스 과제에서 요구하는 프로그래밍 요구 사항 중 하나는 자바 스타일 가이드를 준수하는 것이었다. 처음에는 간단해 보였지만, 코드를 커밋하기 전에 스타일에 맞게 일일이 수정하는 일이 점점 번거로워졌다. 특히, 들여쓰기나 공백 같은 세세한 부분을 계속해서 맞추다 보니 작업 흐름이 끊기는 느낌이 들었다. 그래서 검색을 해보니, 코드 포매터라는 도구를 발견하게 되었다.
- 코드 포매터는 미리 정의된 형식에 따라 코드를 자동으로 정리해주는 도구이다. 포맷팅 단축키(Command + Option + L)를 누르면 지정된 스타일로 코드가 정리되며, 코드를 저장할 때마다 자동으로 포맷팅되도록 설정할 수도 있어 일일이 수동으로 수정하는 수고를 덜 수 있다.
- 또한, 우아한테크코스 스타일 가이드가 자바 기본 스타일 가이드와 약간 다르다는 것을 알게 되었다. 이에 대해 검색하던 중 우테코 코드 포매터를 찾을 수 있었고, 이를 적용해 스타일에 맞춰 더 쉽게 코드를 관리할 수 있었다.
우아한테크코스 스타일 가이드와 관련된 내용은 여기를 참고하면 좋을 것 같다.
💻 IntelliJ 코드 스타일 포매터 등록 방법
▶ xml 파일 저장
- 먼저, 제공한 XML 파일을 로컬 컴퓨터에 저장한다.
- 파일 이름을 WootecoStyle.xml로 저장한다.
▶ 설정 메뉴 열기
- IntelliJ 좌측 상단의 IntelliJ IDEA > Settings를 클릭한다.
▶ Code Style 메뉴로 이동
- 왼쪽 사이드바에서 Editor > Code Style > Java로 이동한다.
▶ Scheme 가져오기
- Scheme의 오른쪽 드롭다운 메뉴에서 Import Scheme > IntelliJ IDEA code style XML을 선택한다.
▶ XML 파일 선택
- 저장한 WootecoStyle.xml 파일을 찾아 선택한다.
▶ 설정 적용
- Apply 또는 OK 버튼을 클릭하여 설정을 저장한다.
🔄 코드 저장 시 포매터 자동 실행 설정
▶ 설정 메뉴 열기
- IntelliJ 좌측 상단의 IntelliJ IDEA > Settings를 클릭한다.
▶ Actions on Save 설정 이동
- 왼쪽 사이드바에서 Tools > Actions on Save로 이동한다.
▶ Reformat Code 활성화
- Reformat code 옵션을 체크하여 저장할 때마다 코드가 자동으로 포맷되도록 설정한다.
- Optimize imports는 선택 사항으로, 체크하면 사용되지 않는 import 문이 자동으로 정리된다.
- Apply 또는 OK 버튼을 클릭하여 설정을 저장한다.
📍 참고 자료
'우아한테크코스' 카테고리의 다른 글
| [우아한테크코스] Java Enum 활용기 (4) | 2024.11.05 |
|---|---|
| [우아한테크코스] 프리코스 3주차 기록 (8) | 2024.11.05 |
| [우아한테크코스] 프리코스 2주차 기록 (2) | 2024.10.29 |
| [우아한테크코스] 프리코스 1주차 기록 (4) | 2024.10.22 |
| [우아한테크코스] 프리코스 시작 전, 목표 설정 및 클린 코드 원칙 정리 (0) | 2024.10.07 |
