🟦 CODE

변수, 함수, 클래스명

• 변수 명사형 id password userId user_id
• 함수 동사 + 명사형 getLoginData

주석

• 다른 사람도 이해할 수 있게 주석 설명 작성하기
• 여러 줄로 작성하더라도 // 한 줄 주석으로 통일
• 코드를 주석 처리한 경우, 코드 맨 윗 줄에 ‘무슨 코드인지 + 왜 주석 처리했는지’ 작성

MySQL

• snake_case

Spring Boot

• camelCase

• 들여쓰기 = 띄어쓰기 4번

• 임시 변수 사용이 자료형의 첫 알파벳부터 시작

  • 예시 for (**int** i=0; i<10; i++) → 다음에 임시 변수가 필요하다면 j, k, l, m, n 순으로 사용
  • 만약 자료형이 char라면 c, d, e, f 순으로 사용

• Postman

  • SSAFY_A509 workspace
  • API 명세서에서 [분류] 기능 으로 제목 작성

• Return 형식

  • baseresponse (출처 🧚‍♀️도연님)

    package com.runstory.api.response;
    
    import lombok.Getter;
    import lombok.RequiredArgsConstructor;
    
    @Getter
    @RequiredArgsConstructor
    public class BaseResponse<T> {
    
        private final static int SUCCESS = 200;
        private final static int NOT_FOUND = 400;
        private final static int FAILED = 500;
        private final static String SUCCESS_MESSAGE = "SUCCESS";
        private final static String NOT_FOUND_MESSAGE = "NOT FOUND";
        private final static String FAILED_MESSAGE = "서버에서 오류가 발생하였습니다.";
        private final static String INVALID_ACCESS_TOKEN = "유효하지 않은 access token.";
        private final static String INVALID_REFRESH_TOKEN = "유효하지 않은 refresh token.";
        private final static String NOT_EXPIRED_TOKEN_YET = "만료되지 않은 토큰 입니다";
        private final int statusCode;
        private final String message;
        private final T data;
        public static <T> BaseResponse<T> success(T body) {
            return new BaseResponse(SUCCESS, SUCCESS_MESSAGE, body);
        }
        public static <T> BaseResponse<T> customSuccess(int statusCode, String message, T body) {
            return new BaseResponse(statusCode, message, body);
        }
        public static <T> BaseResponse<T> fail() {
            return new BaseResponse(FAILED, FAILED_MESSAGE, null);
        }
    
        public static <T> BaseResponse<T> invalidAccessToken() {
            return new BaseResponse(FAILED, INVALID_ACCESS_TOKEN, null);
        }
    
        public static <T> BaseResponse<T> invalidRefreshToken() {
            return new BaseResponse(FAILED, INVALID_REFRESH_TOKEN, null);
        }
    
        public static <T> BaseResponse<T> notExpiredTokenYet() {
            return new BaseResponse(FAILED, NOT_EXPIRED_TOKEN_YET, null);
        }
    }
    

• Controller

  • 예시 (출처 🧚‍♀️도연님)

    @ApiOperation(value = "해시태그 조회", notes = "전체 해시태그를 조회합니다.")
    @GetMapping("/hashtag")
    public BaseResponse<?> getHashtag(){
        List<HashtagDto> hashtags = feedService.getHashtags();
        return BaseResponse.success(hashtags);
    }
    

• Service / Repository

  • 메서드마다 주석 작성

  • 예시

    /** 
     * 건강기능식품 정보 검색 결과 조회하기
     * @param range 키워드를 조회할 검색 범위
     * @param keyword 검색어
     * @return 
     * **/
    public ResponseEntity<?> searchFood(String range, String keyword) {
    	
    }