fixed 持续清理完善注释

fuint-application/src/main/java/com/fuint/common/service/impl/MerchantServiceImpl.java

@@ -80,8 +80,9 @@ public class MerchantServiceImpl extends ServiceImpl<MtMerchantMapper, MtMerchan
     /**
      * 保存商户信息
      *
-     * @param  merchant
+     * @param  merchant 商户信息
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional
@@ -135,6 +136,7 @@ public class MerchantServiceImpl extends ServiceImpl<MtMerchantMapper, MtMerchan
      *
      * @param  id 商户ID
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtMerchant queryMerchantById(Integer id) {
@@ -149,6 +151,7 @@ public class MerchantServiceImpl extends ServiceImpl<MtMerchantMapper, MtMerchan
      *
      * @param  name 商户名称
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtMerchant queryMerchantByName(String name) {
@@ -193,6 +196,7 @@ public class MerchantServiceImpl extends ServiceImpl<MtMerchantMapper, MtMerchan
      * @param  operator 操作人
      * @param  status   状态
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional
@@ -210,6 +214,12 @@ public class MerchantServiceImpl extends ServiceImpl<MtMerchantMapper, MtMerchan
         mtMerchantMapper.updateById(mtMerchant);
     }
 
+    /**
+     * 根据条件查询商户列表
+     *
+     * @param params 查询参数
+     * @return
+     * */
     @Override
     public List<MtMerchant> queryMerchantByParams(Map<String, Object> params) {
         LambdaQueryWrapper<MtMerchant> lambdaQueryWrapper = Wrappers.lambdaQuery();

fuint-application/src/main/java/com/fuint/common/service/impl/MessageServiceImpl.java

@@ -29,7 +29,8 @@ public class MessageServiceImpl extends ServiceImpl<MtMessageMapper, MtMessage>
     /**
      * 添加消息
      *
-     * @param  mtMsg
+     * @param mtMsg 消息参数
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -47,9 +48,10 @@ public class MessageServiceImpl extends ServiceImpl<MtMessageMapper, MtMessage>
     }
 
     /**
-     * 置为已读
+     * 将消息置为已读
      *
-     * @param  msgId
+     * @param  msgId 消息ID
+     * @param
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -70,9 +72,9 @@ public class MessageServiceImpl extends ServiceImpl<MtMessageMapper, MtMessage>
     }
 
     /**
-     * 置为发送
+     * 消息置为发送
      *
-     * @param  msgId
+     * @param msgId 消息ID
      * @return
      */
     @Override
@@ -103,6 +105,9 @@ public class MessageServiceImpl extends ServiceImpl<MtMessageMapper, MtMessage>
 
     /**
      * 获取最新一条未读弹框消息
+     *
+     * @param userId 会员ID
+     * @return
      */
     @Override
     public MtMessage getOne(Integer userId) {
@@ -118,6 +123,8 @@ public class MessageServiceImpl extends ServiceImpl<MtMessageMapper, MtMessage>
 
     /**
      * 获取需要发送的消息
+     *
+     * @return
      */
     @Override
     public List<MtMessage> getNeedSendList() {

fuint-application/src/main/java/com/fuint/common/service/impl/OpenGiftServiceImpl.java

@@ -73,6 +73,7 @@ public class OpenGiftServiceImpl extends ServiceImpl<MtOpenGiftMapper, MtOpenGif
      * 获取开卡赠礼列表
      * @param  paramMap
      * @throws BusinessCheckException
+     * @return
      * */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -123,6 +124,7 @@ public class OpenGiftServiceImpl extends ServiceImpl<MtOpenGiftMapper, MtOpenGif
      *
      * @param  mtOpenGift
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -139,6 +141,7 @@ public class OpenGiftServiceImpl extends ServiceImpl<MtOpenGiftMapper, MtOpenGif
      *
      * @param  id 开卡赠礼ID
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public OpenGiftDto getOpenGiftDetail(Integer id) throws BusinessCheckException {
@@ -152,6 +155,7 @@ public class OpenGiftServiceImpl extends ServiceImpl<MtOpenGiftMapper, MtOpenGif
      * @param  id       开卡赠礼ID
      * @param  operator 操作人
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @OperationServiceLog(description = "删除开卡赠礼")
@@ -170,8 +174,9 @@ public class OpenGiftServiceImpl extends ServiceImpl<MtOpenGiftMapper, MtOpenGif
     /**
      * 更新开卡赠礼
      *
-     * @param  reqDto
+     * @param  reqDto 实体参数
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -215,8 +220,9 @@ public class OpenGiftServiceImpl extends ServiceImpl<MtOpenGiftMapper, MtOpenGif
 
     /**
      * 开卡赠礼
-     * @param userId
-     * @param gradeId
+     *
+     * @param userId 会员ID
+     * @param gradeId 等级ID
      * @return
      * */
     @Override
@@ -310,7 +316,8 @@ public class OpenGiftServiceImpl extends ServiceImpl<MtOpenGiftMapper, MtOpenGif
     }
 
     /**
-     * 处理详情
+     * 赠礼详情
+     *
      * @param  openGiftInfo
      * @return OpenGiftDto
      * */

fuint-application/src/main/java/com/fuint/common/service/impl/OrderServiceImpl.java

@@ -1418,8 +1418,8 @@ public class OrderServiceImpl extends ServiceImpl<MtOrderMapper, MtOrder> implem
     /**
      * 处理订单详情
      *
-     * @param  orderInfo
-     * @param  needAddress  是否获取订单地址
+     * @param  orderInfo 订单信息
+     * @param  needAddress 是否获取订单地址
      * @param  getPayStatus 是否获取支付状态
      * @return UserOrderDto
      * */

fuint-application/src/main/java/com/fuint/common/service/impl/PaymentServiceImpl.java

@@ -162,7 +162,7 @@ public class PaymentServiceImpl implements PaymentService {
     /**
      * 订单支付
      *
-     * @param request
+     * @param request 请求参数
      * @return
      * */
     @Override

fuint-application/src/main/java/com/fuint/common/service/impl/PointServiceImpl.java

@@ -128,8 +128,9 @@ public class PointServiceImpl extends ServiceImpl<MtPointMapper, MtPoint> implem
     /**
      * 添加积分记录
      *
-     * @param  mtPoint
+     * @param  mtPoint 积分参数
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -178,10 +179,11 @@ public class PointServiceImpl extends ServiceImpl<MtPointMapper, MtPoint> implem
     /**
      * 转赠积分
      *
-     * @param userId
-     * @param mobile
-     * @param amount
-     * @param remark
+     * @param userId 会员ID
+     * @param mobile 会员手机
+     * @param amount 积分数
+     * @param remark 备注
+     * @throws BusinessCheckException
      * @return boolean
      */
     @Override

fuint-application/src/main/java/com/fuint/common/service/impl/RefundServiceImpl.java

@@ -145,8 +145,9 @@ public class RefundServiceImpl extends ServiceImpl<MtRefundMapper, MtRefund> imp
     /**
      * 获取用户售后订单列表
      *
-     * @param  paramMap
+     * @param  paramMap 查询参数
      * @throws BusinessCheckException
+     * @return
      * */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -213,8 +214,9 @@ public class RefundServiceImpl extends ServiceImpl<MtRefundMapper, MtRefund> imp
     /**
      * 创建售后订单
      *
-     * @param refundDto
+     * @param refundDto 订单参数
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -266,6 +268,7 @@ public class RefundServiceImpl extends ServiceImpl<MtRefundMapper, MtRefund> imp
      *
      * @param  id 售后订单ID
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public RefundDto getRefundById(Integer id) throws BusinessCheckException {
@@ -289,8 +292,9 @@ public class RefundServiceImpl extends ServiceImpl<MtRefundMapper, MtRefund> imp
     /**
      * 根据订单ID获取售后订单信息
      *
-     * @param  orderId
+     * @param  orderId 订单ID
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtRefund getRefundByOrderId(Integer orderId) {
@@ -308,6 +312,7 @@ public class RefundServiceImpl extends ServiceImpl<MtRefundMapper, MtRefund> imp
      *
      * @param  refundDto
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -334,8 +339,10 @@ public class RefundServiceImpl extends ServiceImpl<MtRefundMapper, MtRefund> imp
 
     /**
      * 同意售后订单
+     *
      * @param refundDto
      * @throws BusinessCheckException
+     * @return
      * */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -491,11 +498,12 @@ public class RefundServiceImpl extends ServiceImpl<MtRefundMapper, MtRefund> imp
 
     /**
      * 发起退款
-     * @param orderId
-     * @param refundAmount
-     * @param remark
-     * @param accountInfo
-     * throws BusinessCheckException;
+     * @param orderId 订单ID
+     * @param refundAmount 售后金额
+     * @param remark 备注
+     * @param accountInfo 后台管理信息
+     * throws BusinessCheckException
+     * @return
      * */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -553,6 +561,10 @@ public class RefundServiceImpl extends ServiceImpl<MtRefundMapper, MtRefund> imp
 
     /**
      * 获取售后订单数量
+     *
+     * @param beginTime 开始时间
+     * @param endTime 结束时间
+     * @return
      * */
     @Override
     public Long getRefundCount(Date beginTime, Date endTime) {

fuint-application/src/main/java/com/fuint/common/service/impl/SendLogServiceImpl.java

@@ -88,6 +88,7 @@ public class SendLogServiceImpl extends ServiceImpl<MtSendLogMapper, MtSendLog>
      *
      * @param reqSendLogDto
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtSendLog addSendLog(ReqSendLogDto reqSendLogDto) {
@@ -116,8 +117,9 @@ public class SendLogServiceImpl extends ServiceImpl<MtSendLogMapper, MtSendLog>
     /**
      * 根据ID查询发券记录
      *
-     * @param id ID
+     * @param id 发券记录ID
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtSendLog querySendLogById(Long id) {
@@ -125,11 +127,12 @@ public class SendLogServiceImpl extends ServiceImpl<MtSendLogMapper, MtSendLog>
     }
 
     /**
-     * 根据ID 删除发券记录
+     * 根据ID删除发券记录
      *
      * @param  id       发券记录ID
      * @param  operator 操作人
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public void deleteSendLog(Long id, String operator) {

fuint-application/src/main/java/com/fuint/common/service/impl/SendSmsServiceImpl.java

@@ -47,20 +47,29 @@ import java.util.stream.Collectors;
 @AllArgsConstructor
 public class SendSmsServiceImpl implements SendSmsService {
 
-     private static final Logger logger = LoggerFactory.getLogger(SendSmsServiceImpl.class);
+    private static final Logger logger = LoggerFactory.getLogger(SendSmsServiceImpl.class);
 
-     /**
-      * 系统环境变量
-      * */
-     private Environment env;
+    /**
+     * 系统环境变量
+     * */
+    private Environment env;
 
-     private MtSmsSendedLogMapper mtSmsSendedLogMapper;
+    private MtSmsSendedLogMapper mtSmsSendedLogMapper;
 
-     /**
-      * 短信模板服务接口
-      * */
-     private SmsTemplateService smsTemplateService;
+    /**
+     * 短信模板服务接口
+     * */
+    private SmsTemplateService smsTemplateService;
 
+    /**
+     * 发送短信
+     *
+     * @param merchantId 商户ID
+     * @param templateUname 模板名
+     * @param phones 发送手机号
+     * @param contentParams 发送参数
+     * @return
+     * */
     @Override
     public Map<Boolean,List<String>> sendSms(Integer merchantId, String templateUname, List<String> phones, Map<String, String> contentParams) throws BusinessCheckException {
         logger.info("使用短信平台发送短信.....");
@@ -197,7 +206,7 @@ public class SendSmsServiceImpl implements SendSmsService {
     /**
      * 发送短信日志记录
      *
-     * @param merchantId 商户号
+     * @param merchantId 商户ID
      * @param phoneNo    短信发送手机号
      * @param message    短信内容
      * @return

fuint-application/src/main/java/com/fuint/common/service/impl/SettingServiceImpl.java

@@ -39,9 +39,10 @@ public class SettingServiceImpl extends ServiceImpl<MtSettingMapper, MtSetting>
     /**
      * 删除配置
      *
-     * @param  merchantId
-     * @param  name
+     * @param  merchantId 商户ID
+     * @param  name 配置名称
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @OperationServiceLog(description = "删除配置信息")
@@ -58,6 +59,7 @@ public class SettingServiceImpl extends ServiceImpl<MtSettingMapper, MtSetting>
      *
      * @param  mtSetting
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -97,9 +99,10 @@ public class SettingServiceImpl extends ServiceImpl<MtSettingMapper, MtSetting>
     /**
      * 获取配置列表
      *
-     * @param  merchantId
-     * @param  type
+     * @param  merchantId 商户ID
+     * @param  type 配置类型
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public List<MtSetting> getSettingList(Integer merchantId, String type) {
@@ -110,9 +113,10 @@ public class SettingServiceImpl extends ServiceImpl<MtSettingMapper, MtSetting>
     /**
      * 根据ID获取配置信息
      *
-     * @param  merchantId
-     * @param  name
+     * @param  merchantId 商户ID
+     * @param  name 配置名称
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtSetting querySettingByName(Integer merchantId, String name) {
@@ -121,6 +125,7 @@ public class SettingServiceImpl extends ServiceImpl<MtSettingMapper, MtSetting>
 
     /**
      * 获取系统上传的根路径
+     *
      * @return
      * */
     @Override
@@ -144,7 +149,8 @@ public class SettingServiceImpl extends ServiceImpl<MtSettingMapper, MtSetting>
 
     /**
      * 获取支付方式列表
-     * @param platform
+     *
+     * @param platform 平台
      * @return
      * */
     @Override

fuint-application/src/main/java/com/fuint/common/service/impl/SettlementServiceImpl.java

@@ -100,6 +100,7 @@ public class SettlementServiceImpl implements SettlementService {
      *
      * @param  requestParam
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -162,9 +163,10 @@ public class SettlementServiceImpl implements SettlementService {
     /**
      * 结算确认
      *
-     * @param  settlementId
-     * @param  operator
+     * @param  settlementId 结算ID
+     * @param  operator 操作人
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -185,9 +187,9 @@ public class SettlementServiceImpl implements SettlementService {
     /**
      * 获取结算详情
      *
-     * @param settlementId
-     * @param page
-     * @param pageSize
+     * @param settlementId 结算ID
+     * @param page 当前页码
+     * @param pageSize 每页数量
      * @return
      * */
     @Override

fuint-application/src/main/java/com/fuint/common/service/impl/SmsTemplateServiceImpl.java

@@ -145,12 +145,19 @@ public class SmsTemplateServiceImpl extends ServiceImpl<MtSmsTemplateMapper, MtS
      * 根据D获取信息
      *
      * @param  id 模板ID
+     * @return
      */
     @Override
     public MtSmsTemplate querySmsTemplateById(Integer id) {
         return mtSmsTemplateMapper.selectById(id);
     }
 
+    /**
+     * 根据参数查询短信模板
+     *
+     * @param params 查询参数
+     * @return
+     * */
     @Override
     public List<MtSmsTemplate> querySmsTemplateByParams(Map<String, Object> params) {
         if (params == null) {

fuint-application/src/main/java/com/fuint/common/service/impl/SourceServiceImpl.java

@@ -34,6 +34,7 @@ public class SourceServiceImpl extends ServiceImpl<TSourceMapper, TSource> imple
     /**
      * 获取有效的角色集合
      *
+     * @param merchantId 商户ID
      * @return
      */
     @Override
@@ -44,6 +45,7 @@ public class SourceServiceImpl extends ServiceImpl<TSourceMapper, TSource> imple
     /**
      * 获取菜单的属性结构
      *
+     * @param merchantId 商户IF
      * @return
      */
     @Override
@@ -77,7 +79,7 @@ public class SourceServiceImpl extends ServiceImpl<TSourceMapper, TSource> imple
     /**
      * 根据菜单ID集合查询菜单列表信息
      *
-     * @param ids
+     * @param ids 菜单ID
      * @return
      */
     @Override
@@ -274,6 +276,10 @@ public class SourceServiceImpl extends ServiceImpl<TSourceMapper, TSource> imple
 
     /**
      * 得到子节点列表
+     *
+     * @param list 菜单列表
+     * @param t 当前节点
+     * @return
      */
     private List<TreeNode> getChildList(List<TreeNode> list, TreeNode t) {
         List<TreeNode> tList = new ArrayList<TreeNode>();
@@ -289,6 +295,10 @@ public class SourceServiceImpl extends ServiceImpl<TSourceMapper, TSource> imple
 
     /**
      * 判断是否有子节点
+     *
+     * @param list 菜单列表
+     * @param t 当前节点
+     * @return
      */
     private boolean hasChild(List<TreeNode> list, TreeNode t) {
         return getChildList(list, t).size() > 0;

fuint-application/src/main/java/com/fuint/common/service/impl/StaffServiceImpl.java

@@ -114,9 +114,9 @@ public class StaffServiceImpl extends ServiceImpl<MtStaffMapper, MtStaff> implem
     /**
      * 保存员工信息
      *
-     * @param  mtStaff
-     * @return
+     * @param  mtStaff 员工参数
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @OperationServiceLog(description = "保存店铺员工")
@@ -167,8 +167,9 @@ public class StaffServiceImpl extends ServiceImpl<MtStaffMapper, MtStaff> implem
     /**
      * 根据ID获取员工信息
      *
-     * @param  id 员工id
+     * @param  id 员工ID
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtStaff queryStaffById(Integer id) {
@@ -177,10 +178,11 @@ public class StaffServiceImpl extends ServiceImpl<MtStaffMapper, MtStaff> implem
     }
 
     /**
-     * 更改员工状态
+     * 修改店铺员工状态
      *
-     * @param  staffId
+     * @param  staffId 员工ID
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @OperationServiceLog(description = "修改店铺员工状态")
@@ -218,6 +220,9 @@ public class StaffServiceImpl extends ServiceImpl<MtStaffMapper, MtStaff> implem
 
     /**
      * 根据条件搜索员工
+     *
+     * @param params 查询参数
+     * @return
      * */
     @Override
     public List<MtStaff> queryStaffByParams(Map<String, Object> params) {
@@ -232,6 +237,7 @@ public class StaffServiceImpl extends ServiceImpl<MtStaffMapper, MtStaff> implem
      *
      * @param mobile 手机号
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtStaff queryStaffByMobile(String mobile) {
@@ -243,6 +249,7 @@ public class StaffServiceImpl extends ServiceImpl<MtStaffMapper, MtStaff> implem
      *
      * @param  userId 会员ID
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtStaff queryStaffByUserId(Integer userId) {

fuint-application/src/main/java/com/fuint/common/service/impl/StockServiceImpl.java

@@ -91,9 +91,10 @@ public class StockServiceImpl extends ServiceImpl<MtStockMapper, MtStock> implem
     /**
      * 新增库存管理记录
      *
-     * @param  stockParam
-     * @param  goodsList
+     * @param  stockParam 库存参数
+     * @param  goodsList 商品列表
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -171,6 +172,7 @@ public class StockServiceImpl extends ServiceImpl<MtStockMapper, MtStock> implem
      * @param  id       ID
      * @param  operator 操作人
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @OperationServiceLog(description = "删除商品分类")
@@ -190,12 +192,19 @@ public class StockServiceImpl extends ServiceImpl<MtStockMapper, MtStock> implem
      *
      * @param  id ID
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtStock queryStockById(Long id) {
         return mtStockMapper.selectById(id.intValue());
     }
 
+    /**
+     * 根据条件查询库存项
+     *
+     * @param params 查询条件
+     * @return
+     * */
     @Override
     public List<MtStockItem> queryItemByParams(Map<String, Object> params) {
         if (params == null) {