관리 메뉴

KorSA

Java Coding Convention 본문

Study Memos/Spring Framework

Java Coding Convention

Praiv. 2021. 5. 18. 18:01
320x100

1. 문자열은 UTF-8 로 통일

2. 윈도우의 CRLF가 섞이지 않도록 에디터와 GIT 설정

3. import 시 static import 가 아닌 이상 * 말고 패키지 명을 모두 명시

4. Indent는 스페이스 4개가 아닌 하드탭 사용, 에디터에서 스페이스와 탭을 구분하여 보여주도록 설정

5. 최대 줄 너비 120으로 줄바꿈을 강제하여 사용한다. 단, package, import 문은 중간에 바꾸지 않고 한 줄로 쓴다.

6. 줄바꿈 허용 위치
- extends 선언 후
- implements 선언 후
- throws 선언 후
- 시작 소괄호( '(' ) 선언 후
- 콤마(,) 후
- . 전
- 연산자 (+, -, *, / 등) 전

7. import 선언 문의 순서도 별도의 Convention이 존재

8. 삼항 연산자, switch-case 문 등에서 사용하는 콜론(:) 의 앞뒤로 공백을 삽입한다.

9. .editorconfig 파일은 다양한 에디터와 IDE에서 공통적으로 지원하는 코드 스타일에 대한 설정 파일이다. 
다양한 에디터로 파일을 고칠 때 같은 규칙을 참조할 수 있도록 가급적 이 파일을 소스 저장소에서 올려서 공유하는 것을 권장한다.

10. Checkstyle은 코딩 컨벤션 검사 도구이다.

11. Gradle 관련 .editorconfig 플러그인 설정과 Chekcstyle 플러그인 설정을 해두고 코드를 작성하자.

728x90
728x90

'Study Memos > Spring Framework' 카테고리의 다른 글

Spring Security 메모  (0) 2021.06.07
스프링 기본  (0) 2021.03.22
Servlet Container, Servlet, 그리고 RequestDispatcher  (0) 2019.01.17
Spring Framework 공부한 내용 정리  (0) 2019.01.15
Comments