1년 전 진행했던 마실가실 프로젝트를 🛠️리팩토링하며 정리한 내용입니다.
오늘은 잔망과 루피의 이름으로 다른 코드 스타일을 용서하지 않을 예정입니다.
여러명이서 진행한 프로젝트인만큼 파일마다 개성이 뚜렷했는데, 찾아다니면서 맞추기에는 효율도 떨어지고 놓치는 부분도 분명이 있을 것이라 생각했습니다.
또 다른 문제는 제가 가진 코드 컨벤션 같은 것이 없기에 다른 이가 만들어 놓은 포맷팅을 우선 일괄적으로 적용하는 것이 필요하겠다는 판단을 했습니다.
그래서 이번 목표는 다른 이의 코드 스타일을 일괄로 한 번에 적용하자! 입니다🤓!
1. xml 형식의 스타일 가이드를 하나 구해봅니다.
* intelliJ java 기준입니다.
https://github.com/google/styleguide/blob/gh-pages/intellij-java-google-style.xml
styleguide/intellij-java-google-style.xml at gh-pages · google/styleguide
Style guides for Google-originated open-source projects - google/styleguide
github.com
woowacourse-docs/styleguide/java/intellij-java-wooteco-style.xml at main · woowacourse/woowacourse-docs
우아한테크코스 문서를 관리하는 저장소. Contribute to woowacourse/woowacourse-docs development by creating an account on GitHub.
github.com
2. IntelliJ에 적용
* Window 기준입니다.
File - Settings - Editor - Code Style - Java
Scheme - 톱니바퀴 - Import Scheme - IntelliJ IDEA code style XML - Apply
3. 코드 저장 시마다 Formmatting 적용 설정
File - Settings - Tools - Actions on Save
* Reformat code: 저장 시마다 formmating 적용
* Optimize imports: 사용하지 않는 import문 제거
🚨 Rearrange code, Run code cleanup: 코드 위치 변경, 불필요한 코드 제거 등의 기능을 제공하지만 사이드 이펙트 우려가 있어 사용하지 않습니다.
4. 전체 파일에 적용
* 개인이 따로 줄 바꾸기 한 게 사라질 수 있으므로 Line Break에 대한 경고창을 확인해야 합니다.
* 개별 파일에서 적용: ctrl + alt + L
* 특정 폴더 내의 모든 파일 적용: Project 창에서 해당 폴더를 클릭한 후 ctrl + alt + L
🚨 Default로 Clean Up Code가 Check되어있으므로 유의
+ 2024.10.03
Code Style을 자동으로 적용하도록 했는데, xml에서 길이가 길어지니 자동 줄바꿈을 해서 저장하는 문제가 있었습니다.
IntelliJ 기준 Settings - Editor - Code Style - Formatter 탭
Do not Formatter에 특정 파일을 추가할 수 있습니다.
🙋♀️
본 포스트는 공부 목적으로 작성하였습니다.
보시는 도중 잘못된 부분이나 개선할 부분이 있다면 댓글로 알려주시면 수정하도록 하겠습니다.
📑
참고 자료
https://yeon-kr.tistory.com/197
[Intellij] Google Java auto-formatting 적용
1) 서론 여러 사람이 함께 코드를 작성할 때는 다양한 스타일의 코드가 작성됩니다. 같은 목적의 코드라도, 개개인의 스타일은 다를 수밖에 없는데요. 만약 큰 회사 혹은 조직이라면 통일된 코드
yeon-kr.tistory.com
[IntelliJ] 코드 스타일을 설정해보자 (feat.우테코)
오늘부터 시작한 우아한 테크코스 6기의 프리코스를 수행하면서기능 구현에 집중하느라 코드 포맷을 정리하지 못해, 기능 구현 이후 Commit 직전일일히 객체를 찾아다니며 Command + Option + L (코드
velog.io
'PlayGround > 마실가실 리팩토링' 카테고리의 다른 글
[1년 후 마실가실] 커밋 규칙 (2) | 2024.10.01 |
---|---|
[1년 후 마실가실] @Valid와 @RestControllerAdvice (0) | 2024.09.29 |
[1년 후 마실가실] .gitignore 재적용 (0) | 2024.09.23 |
[1년 후 마실가실] @WebMvcTest Security 403 (0) | 2024.09.21 |
[1년 후 마실가실] PostMan과 Controller Test Code (0) | 2024.09.19 |