이번 프로젝트에서는 네이버의 코드 컨벤션을 따라하려고함

.editorconfig 설정

# top-most EditorConfig file
root = true

#1. 공통 설정 (모든파일)
[*]
# [encoding-utf8]
charset = utf-8

#줄 끝 문자 
# [newline-lf]
end_of_line = lf

#파일 끝에 반드시 새줄 추가
# [newline-eof]
insert_final_newline = true

#2. 파일 형식별 예외 설정
[*.bat]
end_of_line = crlf

#3. Java 파일 설정
#들여쓰기 스타일: tab 사용
[*.java]
# [indentation-tab]
indent_style = tab

#들여쓰기 크기 4칸
# [4-spaces-tab]
indent_size = 4

#탬 문자를 공백 4칸으로 처리
tab_width = 4

#줄 끝에 붙은 불필요한 공백 제거
# [no-trailing-spaces]
trim_trailing_whitespace = true

#최대 코드 가로 길이 120
[line-length-120]
max_line_length = 120
항목 설정
root = true 최상위 설정 파일
charset = utf-8 파일 인코딩을 UTF-8 로 설정
end_of_line = lf 줄바꿈 문자를 LF 로 통일
insert_final_newline = true 파일 저장시 마지막 새줄 삽입
trim_trailing_whitespace = true 줄 끝에 이는 공백을 자동으로 제거함
indent_style = tab 들여쓰기 스타일 (tab) 설정
ident_size = 4 들여쓰기 크기 4칸
tab_width = 4 탭 문자를 공백 4칸
max_line_length = 120 코드 가로길이를 120자로 제한

Javadoc convention

참고 문헌 : https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html

적용대상

public 및 보호 protected API 요소(클래스, 인터페이스, 메소드, 필드, 생성자)에는 Javadoc을 작성

비공개(private) 요소는 필요에 따라 선택적으로 작성 → private 요소는 별도 JavaDoc 미작성으로 통일

주석의 기본형식

Javadoc의 주석은 /** 로 시작해서 */ 로 끝난다.

각 줄의 시작은 * 로 시작한다.

내용 및 구조 : 주요 설명과 블록 태그 두 부분으로 구성됨