[FEAT] 유저 부분 주석 추가 (#97)

src/main/java/kr/sesac/aoao/server/user/domain/User.java

@@ -7,6 +7,12 @@
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 
+/**
+ * 유저 도메인
+ *
+ * @author 이상민
+ * @since 2024.01.19
+ */
 @Getter
 @AllArgsConstructor
 public class User {

src/main/java/kr/sesac/aoao/server/user/exception/UserErrorCode.java

@@ -5,6 +5,11 @@
 import kr.sesac.aoao.server.global.exception.ErrorCode;
 import lombok.RequiredArgsConstructor;
 
+/**
+ * 유저 관련 에러 코드 추가
+ * @author 이상민
+ * @since 2024.01.19
+ */
 @RequiredArgsConstructor
 public enum UserErrorCode implements ErrorCode {
 

src/main/java/kr/sesac/aoao/server/user/jwt/JwtAuthenticationFilter.java

@@ -29,6 +29,12 @@ public class JwtAuthenticationFilter extends OncePerRequestFilter {
 
 	private final JwtTokenProvider jwtTokenProvider;
 
+	/**
+	 * jwt 필터
+	 *
+	 * @author 이상민
+	 * @since 2024.01.19
+	 */
 	@Override
 	protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response,
 		FilterChain filterChain) throws ServletException, IOException {

src/main/java/kr/sesac/aoao/server/user/jwt/JwtTokenProvider.java

@@ -44,7 +44,6 @@
 @Slf4j
 public class JwtTokenProvider {
 
-	// @Value("${security.jwt.secret.key}")
 	private String secretKey =
 		"c2lsdmVybmluZS10ZWNoLXNwcmluZy1ib290LWp3dC10dXRvcmlhbC1zZWNyZXQtc2lsdmVybmluZS10ZWNoLXNwcmluZy1ib290LWp3dC10dXRvcmlhbC1zZWNyZXQK";
 

src/main/java/kr/sesac/aoao/server/user/jwt/Subject.java

@@ -2,6 +2,10 @@
 
 import lombok.Getter;
 
+/**
+ * @author 이상민
+ * @since 2024.01.19
+ */
 @Getter
 public class Subject {
 

src/main/java/kr/sesac/aoao/server/user/repository/RefreshTokenEntity.java

@@ -11,6 +11,10 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * @author 이상민
+ * @since 2024.01.19
+ */
 @Getter
 @Entity
 @NoArgsConstructor(access = AccessLevel.PROTECTED)

src/main/java/kr/sesac/aoao/server/user/repository/TokenJpaRepository.java

@@ -4,6 +4,10 @@
 
 import org.springframework.data.jpa.repository.JpaRepository;
 
+/**
+ * @author 이상민
+ * @since 2024.01.19
+ */
 public interface TokenJpaRepository extends JpaRepository<RefreshTokenEntity, String> {
 
 	Optional<RefreshTokenEntity> findByEmail(String email);

src/main/java/kr/sesac/aoao/server/user/repository/UserEntity.java

@@ -26,6 +26,10 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * @author 이상민
+ * @since 2024.01.19
+ */
 @Entity
 @Getter
 @Table(name = "users")

src/main/java/kr/sesac/aoao/server/user/repository/UserJpaRepository.java

@@ -4,6 +4,10 @@
 
 import org.springframework.data.jpa.repository.JpaRepository;
 
+/**
+ * @author 이상민
+ * @since 2024.01.19
+ */
 public interface UserJpaRepository extends JpaRepository<UserEntity, Long> {
 
 	Optional<UserEntity> findByEmail(String email);

src/main/java/kr/sesac/aoao/server/user/repository/UserType.java

@@ -1,5 +1,10 @@
 package kr.sesac.aoao.server.user.repository;
 
+/**
+ * 회원가입 타입
+ * @author 이상민
+ * @since 2024.01.19
+ */
 public enum UserType {
 	BASIC, KAKAO
 }

src/main/java/kr/sesac/aoao/server/user/service/KaKaoLoginService.java

@@ -12,6 +12,10 @@
 import kr.sesac.aoao.server.user.repository.UserJpaRepository;
 import lombok.RequiredArgsConstructor;
 
+/**
+ * @author 이상민
+ * @since 2024.01.24
+ */
 @Service
 @RequiredArgsConstructor
 @Transactional

src/main/java/kr/sesac/aoao/server/user/service/UserService.java

@@ -12,6 +12,10 @@
 import kr.sesac.aoao.server.user.jwt.UserCustomDetails;
 import kr.sesac.aoao.server.user.repository.UserEntity;
 
+/**
+ * @author 이상민
+ * @since 2024.01.19
+ */
 public interface UserService {
 
 	User signUp(SignUpRequest signUpRequest);

src/main/java/kr/sesac/aoao/server/user/service/UserServiceImpl.java

@@ -188,6 +188,12 @@ public MyPageResponse getProfile(String username, Long userId) {
 		);
 	}
 
+	/**
+	 * 이메일 중복 함수
+	 *
+	 * @author 이상민
+	 * @since 2024.01.24
+	 */
 	@Override
 	public void duplicatedEmail(String email) {
 		Optional<UserEntity> user = userJpaRepository.findByEmail(email);
@@ -196,6 +202,12 @@ public void duplicatedEmail(String email) {
 		}
 	}
 
+	/**
+	 * 닉네임 중복 함수
+	 *
+	 * @author 이상민
+	 * @since 2024.01.24
+	 */
 	@Override
 	public void duplicationNickname(String nickname) {
 		Optional<UserEntity> user = userJpaRepository.findByNickname(nickname);
@@ -283,6 +295,12 @@ public void deleteUser(Long userId) {
 		userJpaRepository.delete(new UserEntity(user));
 	}
 
+	/**
+	 * 로그아웃
+	 *
+	 * @since 2024.01.27
+	 * @author 이상민
+	 */
 	@Override
 	public void logout(UserEntity userEntity) {
 		Optional<RefreshTokenEntity> refreshTokenEntity = tokenJpaRepository.findByEmail(userEntity.getEmail());