/**
* @author 김팡야
* @version 1.0.0
* @since 1.0.0
*/
| annotaion | Description | Example |
|---|---|---|
| @author | 작성자 | @author 김팡야 |
| @return | 반환값 | |
| @param | 메소드의 매개변수 / 인자값 설명 | |
| @exception | 발생할 수 있는 Exception 정의 | |
| @throws | 코드에서 throw 할 수 있는 예외상황 정의 | |
| @version | 구현체(클래스, 메소드,변수 등)의 버전 | |
| @deprecated | 해당 구현체가 곧 삭제, 업데이트 중단을 의미 | |
| @since | 해당 구현체가 추가된 버전 | |
| @see | 외부 링크나 텍스트, 다른 필드나 메소드를 링크할 때 사용 | 외부 링크 : a href 태그 이용내부 참조 : 패키지명#생성자/ 필드 / 메소드명 |
| @link | see와 동일한 기능, 참조에 대한 링크 제공 | |
| @serial | Serializable Interface에 사용 | |
| @serialDate | writeObject writeExternal 메소드로 작성된 추가적 데이터를 설명 | |
| @serialField | serialPersistnetFields 배열의 모든 필드에 사용 |
구글 플러그인 사용
만약 안되면
https://anywaydevlog.tistory.com/110
Tab size : 4/ Indent : 4 적용 후 ok
File → Tools → Actions on Save → Reformat code, Optimize imports
이제 저장할때마다 자동 포맷이 됩니다
클래스명 & 파일명 파스칼표기법 UserName
데이터베이스 컬럼명 스네이크표기법 user_name
데이터베이스 테이블명 복수 users members
배열 리스트 복수형
dto
도메인 {요청 / 반환} Dto
PostRequestDto