commit

batch-quartz/src/main/java/com/spring/common/jpa/AuditEntity.java

@@ -14,23 +14,57 @@ import org.springframework.data.jpa.domain.support.AuditingEntityListener;
 
 import lombok.Getter;
 
+/**
+ * 모든 감사 엔티티의 기본 클래스를 정의하는 추상 클래스입니다.
+ * 
+ * <p>이 클래스는 생성일, 생성자, 수정일 및 수정자를 포함하여
+ * 감사 관련 정보를 관리하는 데 사용됩니다.</p>
+ * 
+ * <p>JPA의 @MappedSuperclass 어노테이션을 사용하여 이 클래스를 상속받는
+ * 모든 엔티티가 이 필드를 포함할 수 있도록 합니다.</p>
+ * 
+ * @author mindol
+ * @version 1.0
+ */
 @Getter
 @MappedSuperclass
 @EntityListeners(AuditingEntityListener.class)
 public abstract class AuditEntity {
 
+    /**
+     * 엔티티가 생성된 날짜 및 시간입니다.
+     * 
+     * <p>이 필드는 엔티티가 처음 생성될 때 자동으로 설정되며,
+     * 업데이트할 수 없습니다.</p>
+     */
     @CreatedDate
     @Column(name = "CREATED_DATE", updatable = false, insertable = true)
     protected LocalDateTime createdDate;
 
+    /**
+     * 엔티티를 생성한 사용자의 ID입니다.
+     * 
+     * <p>이 필드는 엔티티가 생성될 때 자동으로 설정되며,
+     * 업데이트할 수 없습니다.</p>
+     */
     @CreatedBy
     @Column(name = "CREATED_BY", updatable = false, insertable = true, length = 50)
     protected String createdBy;
 
+    /**
+     * 엔티티가 마지막으로 수정된 날짜 및 시간입니다.
+     * 
+     * <p>이 필드는 엔티티가 수정될 때 자동으로 설정됩니다.</p>
+     */
     @LastModifiedDate
     @Column(name = "MODIFIED_DATE", updatable = true, insertable = true)
     protected LocalDateTime modifiedDate;
 
+    /**
+     * 엔티티를 마지막으로 수정한 사용자의 ID입니다.
+     * 
+     * <p>이 필드는 엔티티가 수정될 때 자동으로 설정됩니다.</p>
+     */
     @LastModifiedBy
     @Column(name = "MODIFIED_BY", updatable = true, insertable = true, length = 50)
     protected String modifiedBy;