코드규칙 - ranking-yang/project-workspace GitHub Wiki
💬 코드 규칙
- 폴더/클래스 규칙
- 폴더명/클래스명은 소문자로 작성합니다 (폴더명은 아래를 참고)
- 컨트롤러의 이름은 페이지이름+Controller로 작성합니다
- Service는 하나의 Service로 모두 관리합니다
- 페이지 별 jsp는 view폴더에 페이지 이름의 폴더를 만들어 해당 폴더 내부에 생성하여 사용합니다
- webapp/resources 아래에 페이지 별 폴더를 만들어 페이지 별로 css, js를 개별적으로 관리합니다(css, js 폴더 생성)
- DTO는 DTO 패키지 하나로 관리합니다
- 여러 페이지에서 공통으로 사용하는 기능과 자원들은 webapp/resources/common 폴더에서 관리합니다
- 여러 클래스에서 공통으로 사용하는 코드는 root패키지 아래의 common패키지에서 관리합니다
- 각 페이지 별 폴더명
- 메인 : main
- 공연, 전시, 체험, 키즈 상세페이지 : product-list
- 상품 상세페이지(상, 하단) : detail
- 결제완료 : after-payment
- 마이페이지 : mypage
- 고객센터 : as
- 로그인 : login
- 회원가입 : join
- 관리자 : admin
- 변수명 규칙
- DTO는 DB와의 연동성을 위해 스네이크 케이스로 작성합니다
String user_id
- 나머지 변수, 함수, 상수의 이름에는 모두 소문자 카멜케이스를 사용합니다
String userID
- 화면 규칙
- 폰트 : Noto Sans
- 색상 (메인: #46c8b4/ 배경: #f4f4f4)