| 분류 | 명명법 | 예시 | 기타 |
|---|---|---|---|
| 패키지명 | 전부 소문자 | ||
| 명사로 정의 | com.sparta.~ | ||
| org.sparta.~ | |||
| 클래스 | PascalCase | ||
| : 첫글자 대문자, 이어지는 단어의 첫글자를 공백없이 대문자 | TodoController | ||
| **변수명, | |||
| 메서드명** | camelCase | ||
| : 첫글자 소문자, 이어지는 단어의 첫글자를 공백없이 대문자 | saveTodo() | Boolean 타입의 변수, | |
| 메서드 명은 접두사에 is붙이기 | |||
| : isSaveCheck | |||
| JPA Auditing | camelCase | ||
| : 첫글자 소문자, 이어지는 단어의 첫글자를 공백없이 대문자 | createdAt | ||
| updateAt | |||
| deletedAt | |||
| DTO 명 | 엔티티명 + 행동 동사 + Request/Response + Dto | ||
| ⇒ PascalCase | TodoSaveRequestDto | ||
| TodoSearchRequestDto | |||
| **상수, | |||
| ErrorCode** | 전체 대문자를 사용하고, 언더바로 공백 구분 | USER_NOT_FOUND |
| 분류 | 메서드 명명법 | 예시 | 기타 |
|---|---|---|---|
| 생성 | save + 엔티티 | saveTodo() | |
| 단건 조회 | get + 엔티티 | ||
| get + 엔티티 + 조회항목 | getTodo() | ||
| getTodoTitle() | |||
| 다건 조회 (+검색) | get + 엔티티 + s | ||
| get + 엔티티 + 조회항목 + s | getTodos() | ||
| getTodoTitles() | searchTodos() | ||
| 수정 | update + 엔티티 | ||
| update + 엔티티 + 수정항목 | updateTodo() | ||
| updateTodoTitle() | |||
| 삭제 | delete + 엔티티 | deleteTodo() |
| 분류 | 명명법 | 예시 | 기타 |
|---|---|---|---|
| Table 이름 | p_테이블명 | ||
| snake_case | |||
| : 소문자 단어와 단어 사이의 공백을 _(언더바) 사용해서 명명 | p_user | ||
| p_todo | created_at | ||
| updated_at | |||
| deleted_at | |||
| Column 이름 | snake_case | ||
| : 소문자 단어와 단어 사이의 공백을 _(언더바) 사용해서 명명 | user_id |
@Table(name=”명명된 테이블명”) 과 @Column(name=”명명된 칼럼명”) 으로 Database 이름 명명법에 맞게 DB가 생성될 수 있도록 지정 필수!!!| 분류 | 명명법 | 예시 | 기타 |
|---|---|---|---|
| REST API | kebab-case (공백에-하이픈-사용) | ||
| 하이픈을 사용한 복수형 명사로 명명하기 | |||
| 계층화 하기 | restful-services | ||
| JSON | camelCase | ||
| : 첫글자 소문자, 이어지는 단어의 첫글자를 공백없이 대문자 | { |
”userName” : String
} | |
표준은 X
소통에 드는 리소스를 줄이기 위함
/member/get/item/hello (x)
/members/items (o)
/members/ (x)
/members (o)
/restful_services (x)
/restful-services (o)
/image.svg (x)
/images (o)
/items/{memberId}/members/{itemId} (x)
/members/{memberId}/items/{itemId} (o)
| 분류 | 명명법 | 예시 | 기타 |
|---|---|---|---|
| 2문장 이상 | 긴 주석 (/* */) | /* 긴 주석입니다. */ | |
| 1문장 | 짧은 주석 (//) | // 짧은 주석입니다. |
Controller, Service Method를 작성 시