docs: 完善注释

This commit is contained in:
Ray.Hao
2025-01-14 20:17:18 +08:00
parent 694cd2f190
commit e43883f7c2
2 changed files with 15 additions and 16 deletions

View File

@@ -3,17 +3,16 @@ package com.youlai.boot;
import org.springframework.boot.SpringApplication; import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.ConfigurationPropertiesScan; import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
import org.springframework.scheduling.annotation.EnableScheduling;
/** /**
* 应用启动类 * 应用启动类
* *
* @author Ray * @author Ray.Hao
* @since 0.0.1 * @since 0.0.1
*/ */
@SpringBootApplication @SpringBootApplication
@ConfigurationPropertiesScan // 开启配置属性绑定 @ConfigurationPropertiesScan // 开启配置属性绑定
@EnableScheduling // 开启定时任务 // @EnableScheduling // 开启定时任务
public class YouLaiBootApplication { public class YouLaiBootApplication {
public static void main(String[] args) { public static void main(String[] args) {

View File

@@ -14,9 +14,9 @@ import org.apache.ibatis.annotations.Mapper;
import java.util.List; import java.util.List;
/** /**
* 用户持久层 * 用户持久层接口
* *
* @author haoxr * @author Ray.Hao
* @since 2022/1/14 * @since 2022/1/14
*/ */
@Mapper @Mapper
@@ -25,9 +25,9 @@ public interface UserMapper extends BaseMapper<User> {
/** /**
* 获取用户分页列表 * 获取用户分页列表
* *
* @param page * @param page 分页参数
* @param queryParams 查询参数 * @param queryParams 查询参数
* @return * @return 用户分页列表
*/ */
@DataPermission(deptAlias = "u") @DataPermission(deptAlias = "u")
Page<UserBO> getUserPage(Page<UserBO> page, UserPageQuery queryParams); Page<UserBO> getUserPage(Page<UserBO> page, UserPageQuery queryParams);
@@ -36,15 +36,15 @@ public interface UserMapper extends BaseMapper<User> {
* 获取用户表单详情 * 获取用户表单详情
* *
* @param userId 用户ID * @param userId 用户ID
* @return * @return 用户表单详情
*/ */
UserForm getUserFormData(Long userId); UserForm getUserFormData(Long userId);
/** /**
* 根据用户名获取认证信息 * 根据用户名获取认证信息
* *
* @param username * @param username 用户名
* @return * @return 认证信息
*/ */
UserAuthInfo getUserAuthInfo(String username); UserAuthInfo getUserAuthInfo(String username);
@@ -52,23 +52,23 @@ public interface UserMapper extends BaseMapper<User> {
* 根据微信openid获取用户认证信息 * 根据微信openid获取用户认证信息
* *
* @param openid 微信openid * @param openid 微信openid
* @return * @return 认证信息
*/ */
UserAuthInfo getUserAuthInfoByOpenId(String openid); UserAuthInfo getUserAuthInfoByOpenId(String openid);
/** /**
* 根据手机号获取用户认证信息 * 根据手机号获取用户认证信息
* *
* @param mobile * @param mobile 手机号
* @return * @return 认证信息
*/ */
UserAuthInfo getUserAuthInfoByMobile(String mobile); UserAuthInfo getUserAuthInfoByMobile(String mobile);
/** /**
* 获取导出用户列表 * 获取导出用户列表
* *
* @param queryParams * @param queryParams 查询参数
* @return * @return 导出用户列表
*/ */
@DataPermission(deptAlias = "u") @DataPermission(deptAlias = "u")
List<UserExportDTO> listExportUsers(UserPageQuery queryParams); List<UserExportDTO> listExportUsers(UserPageQuery queryParams);
@@ -77,7 +77,7 @@ public interface UserMapper extends BaseMapper<User> {
* 获取用户个人中心信息 * 获取用户个人中心信息
* *
* @param userId 用户ID * @param userId 用户ID
* @return * @return 用户个人中心信息
*/ */
UserBO getUserProfile(Long userId); UserBO getUserProfile(Long userId);