fixed 持续规范注释

fuint-application/src/main/java/com/fuint/common/service/DutyService.java

@@ -21,7 +21,7 @@ public interface DutyService extends IService<TDuty> {
     /**
      * 角色保存方法
      *
-     * @param duty
+     * @param duty 角色信息
      * @return
      */
     void saveDuty(TDuty duty, List<TSource> sources) throws BusinessCheckException;
@@ -38,7 +38,7 @@ public interface DutyService extends IService<TDuty> {
     /**
      * 根据ID获取角色实体
      *
-     * @param roleId
+     * @param roleId 角色ID
      * @return
      */
     TDuty getRoleById(Long roleId);
@@ -54,7 +54,7 @@ public interface DutyService extends IService<TDuty> {
     /**
      * 根据ID数组获取角色集合
      *
-     * @param ids
+     * @param ids 角色ID
      * @return
      */
     List<TDuty> findDatasByIds(String[] ids);
@@ -62,8 +62,8 @@ public interface DutyService extends IService<TDuty> {
     /**
      * 删除方法
      *
-     * @param merchantId
-     * @param dutyId
+     * @param merchantId 商户ID
+     * @param dutyId 角色ID
      * @return
      */
     void deleteDuty(Integer merchantId, long dutyId) throws BusinessCheckException;
@@ -80,7 +80,8 @@ public interface DutyService extends IService<TDuty> {
     /**
      * 修改角色
      *
-     * @param tduty
+     * @param tduty 角色信息
+     * @param sources 菜单列表
      * @return
      */
     void updateDuty(TDuty tduty, List<TSource> sources) throws BusinessCheckException;
@@ -88,8 +89,8 @@ public interface DutyService extends IService<TDuty> {
     /**
      * 根据角色名称合状态查询角色
      *
-     * @param merchantId
-     * @param name
+     * @param merchantId 商户ID
+     * @param name 角色名称
      * @return
      */
     TDuty findByName(Integer merchantId, String name);
@@ -97,7 +98,7 @@ public interface DutyService extends IService<TDuty> {
     /**
      * 根据角色名称获取已经分配的菜单ID集合
      *
-     * @param dutyId
+     * @param dutyId 角色ID
      * @return
      */
     List<Long> getSourceIdsByDutyId(Integer dutyId);
@@ -105,7 +106,7 @@ public interface DutyService extends IService<TDuty> {
     /**
      * 获取角色的树形结构
      *
-     * @param merchantId
+     * @param merchantId 商户ID
      * @return
      */
     List<TreeNode> getDutyTree(Integer merchantId);
@@ -113,7 +114,7 @@ public interface DutyService extends IService<TDuty> {
     /**
      * 根据账户获取角色
      *
-     * @param accountId
+     * @param accountId 账号ID
      * @return
      */
     List<Long> findDutiesByAccountId(Integer accountId);

fuint-application/src/main/java/com/fuint/common/service/GiveService.java

@@ -48,11 +48,11 @@ public interface GiveService extends IService<MtGive> {
     MtGive queryGiveById(Long id) throws BusinessCheckException;
 
     /**
-     * 根据条件搜索详情
+     * 根据条件搜索转赠详情
      *
      * @param params
      * @throws BusinessCheckException
      * @return
      * */
-    List<MtGiveItem> queryItemByParams(Map<String, Object> params) throws BusinessCheckException;
+    List<MtGiveItem> queryItemByParams(Map<String, Object> params);
 }

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

@@ -44,6 +44,13 @@ public class DutyServiceImpl extends ServiceImpl<TDutyMapper, TDuty> implements
 
     private TDutySourceMapper tDutySourceMapper;
 
+    /**
+     * 获取有效的角色集合
+     *
+     * @param merchantId 商户ID
+     * @param accountId  账号ID
+     * @return
+     */
     @Override
     public List<TDuty> getAvailableRoles(Integer merchantId, Integer accountId) {
         List<TDuty> result = tDutyMapper.findByStatus(merchantId, StatusEnum.ENABLED.getKey());
@@ -65,6 +72,12 @@ public class DutyServiceImpl extends ServiceImpl<TDutyMapper, TDuty> implements
         return result;
     }
 
+    /**
+     * 根据ID获取角色实体
+     *
+     * @param roleId 角色ID
+     * @return
+     */
     @Override
     public TDuty getRoleById(Long roleId) {
         TDuty htDuty = tDutyMapper.selectById(roleId);
@@ -74,7 +87,7 @@ public class DutyServiceImpl extends ServiceImpl<TDutyMapper, TDuty> implements
     /**
      * 根据ID数组获取角色集合
      *
-     * @param ids
+     * @param ids 角色ID
      * @return
      */
     @Override
@@ -89,7 +102,7 @@ public class DutyServiceImpl extends ServiceImpl<TDutyMapper, TDuty> implements
     /**
      * 删除角色
      *
-     * @param dutyId
+     * @param dutyId 角色ID
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -106,8 +119,8 @@ public class DutyServiceImpl extends ServiceImpl<TDutyMapper, TDuty> implements
     /**
      * 更新角色状态
      *
-     * @param merchantId
-     * @param dutyStatusRequest
+     * @param merchantId 商户ID
+     * @param dutyStatusRequest 请求参数
      * @return
      */
     @Override
@@ -131,7 +144,8 @@ public class DutyServiceImpl extends ServiceImpl<TDutyMapper, TDuty> implements
     /**
      * 修改角色
      *
-     * @param tduty
+     * @param tduty 角色信息
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -169,8 +183,8 @@ public class DutyServiceImpl extends ServiceImpl<TDutyMapper, TDuty> implements
     /**
      * 根据角色名称合状态查询角色
      *
-     * @param merchantId
-     * @param name
+     * @param merchantId 商户ID
+     * @param name 角色名称
      * @return
      */
     @Override
@@ -181,7 +195,7 @@ public class DutyServiceImpl extends ServiceImpl<TDutyMapper, TDuty> implements
     /**
      * 根据角色名称获取已经分配的菜单ID集合
      *
-     * @param dutyId
+     * @param dutyId 角色ID
      * @return
      */
     @Override
@@ -192,7 +206,8 @@ public class DutyServiceImpl extends ServiceImpl<TDutyMapper, TDuty> implements
     /**
      * 角色保存方法
      *
-     * @param duty
+     * @param duty 角色信息
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -216,6 +231,7 @@ public class DutyServiceImpl extends ServiceImpl<TDutyMapper, TDuty> implements
     /**
      * 分页查询后台角色
      * @param paginationRequest
+     * @return
      * */
     @Override
     public PaginationResponse<TDuty> findDutiesByPagination(PaginationRequest paginationRequest) {
@@ -279,7 +295,7 @@ public class DutyServiceImpl extends ServiceImpl<TDutyMapper, TDuty> implements
     /**
      * 根据账户获取角色
      *
-     * @param accountId
+     * @param accountId 账号ID
      * @return
      */
     @Override

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

@@ -141,6 +141,7 @@ public class GiveServiceImpl extends ServiceImpl<MtGiveMapper, MtGive> implement
      *
      * @param  giveParam
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -299,12 +300,19 @@ public class GiveServiceImpl extends ServiceImpl<MtGiveMapper, MtGive> implement
      *
      * @param id ID
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtGive queryGiveById(Long id) {
         return mtGiveMapper.selectById(id.intValue());
     }
 
+    /**
+     * 根据条件搜索转赠详情
+     *
+     * @param params 转赠查询条件
+     * @return
+     * */
     @Override
     public List<MtGiveItem> queryItemByParams(Map<String, Object> params) {
         if (params == null) {

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

@@ -300,6 +300,7 @@ public class GoodsServiceImpl extends ServiceImpl<MtGoodsMapper, MtGoods> implem
      *
      * @param  id 商品ID
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtGoods queryGoodsById(Integer id) {
@@ -313,9 +314,10 @@ public class GoodsServiceImpl extends ServiceImpl<MtGoodsMapper, MtGoods> implem
     /**
      * 根据编码获取商品信息
      *
-     * @param  merchantId
-     * @param  goodsNo
+     * @param  merchantId 商户ID
+     * @param  goodsNo 商品编码
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtGoods queryGoodsByGoodsNo(Integer merchantId, String goodsNo) {
@@ -417,6 +419,7 @@ public class GoodsServiceImpl extends ServiceImpl<MtGoodsMapper, MtGoods> implem
      * @param  id ID
      * @param  operator 操作人
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @OperationServiceLog(description = "删除商品信息")
@@ -434,11 +437,12 @@ public class GoodsServiceImpl extends ServiceImpl<MtGoodsMapper, MtGoods> implem
     /**
      * 获取店铺的商品列表
      *
-     * @param storeId
-     * @param keyword
-     * @param cateId
-     * @param page
-     * @param pageSize
+     * @param storeId 店铺ID
+     * @param keyword 关键字
+     * @param cateId 分类ID
+     * @param page 当前页码
+     * @param pageSize 每页页数
+     * @throws BusinessCheckException
      * @return
      * */
     @Override
@@ -503,7 +507,7 @@ public class GoodsServiceImpl extends ServiceImpl<MtGoodsMapper, MtGoods> implem
     /**
      * 通过SKU获取规格列表
      *
-     * @param skuId
+     * @param skuId skuID
      * @return
      * */
     @Override
@@ -535,7 +539,7 @@ public class GoodsServiceImpl extends ServiceImpl<MtGoodsMapper, MtGoods> implem
     /**
      * 获取商品规格详情
      *
-     * @param specId
+     * @param specId 规格ID
      * @return
      * */
     @Override
@@ -547,7 +551,7 @@ public class GoodsServiceImpl extends ServiceImpl<MtGoodsMapper, MtGoods> implem
     /**
      * 更新已售数量
      *
-     * @param goodsId
+     * @param goodsId 商品ID
      * @return
      * */
     @Override
@@ -559,7 +563,7 @@ public class GoodsServiceImpl extends ServiceImpl<MtGoodsMapper, MtGoods> implem
     /**
      * 获取选择商品列表
      *
-     * @param params
+     * @param params 查询参数
      * @return
      */
     @Override
@@ -632,10 +636,10 @@ public class GoodsServiceImpl extends ServiceImpl<MtGoodsMapper, MtGoods> implem
     /**
      * 获取商品销售排行榜
      *
-     * @param merchantId
-     * @param storeId
-     * @param startTime
-     * @param endTime
+     * @param merchantId 商户ID
+     * @param storeId 店铺ID
+     * @param startTime 开始时间
+     * @param endTime 结束时间
      * @return
      * */
     @Override

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

@@ -135,8 +135,8 @@ public class MemberServiceImpl extends ServiceImpl<MtUserMapper, MtUser> impleme
 
     /**
      * 获取当前操作会员信息
-     * @param userId
-     * @param token
+     * @param userId 会员ID
+     * @param token 登录token
      * @return
      * */
     @Override
@@ -312,8 +312,9 @@ public class MemberServiceImpl extends ServiceImpl<MtUserMapper, MtUser> impleme
     /**
      * 添加会员
      *
-     * @param  mtUser
+     * @param  mtUser 会员信息
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @OperationServiceLog(description = "新增会员信息")
@@ -404,8 +405,9 @@ public class MemberServiceImpl extends ServiceImpl<MtUserMapper, MtUser> impleme
     /**
      * 更新会员信息
      *
-     * @param  mtUser
+     * @param  mtUser 会员信息
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -458,8 +460,9 @@ public class MemberServiceImpl extends ServiceImpl<MtUserMapper, MtUser> impleme
     /**
      * 通过手机号新增会员
      *
-     * @param  mobile
+     * @param  mobile 手机号
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -496,9 +499,10 @@ public class MemberServiceImpl extends ServiceImpl<MtUserMapper, MtUser> impleme
     /**
      * 根据手机号获取会员信息
      *
-     * @param  merchantId
+     * @param  merchantId 商户ID
      * @param  mobile 手机号
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtUser queryMemberByMobile(Integer merchantId, String mobile) {
@@ -518,7 +522,7 @@ public class MemberServiceImpl extends ServiceImpl<MtUserMapper, MtUser> impleme
      *
      * @param  merchantId 商户ID
      * @param  userNo     会员号
-     * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtUser queryMemberByUserNo(Integer merchantId, String userNo) {
@@ -537,8 +541,8 @@ public class MemberServiceImpl extends ServiceImpl<MtUserMapper, MtUser> impleme
      * 根据会员ID获取会员信息
      *
      * @param  id 会员ID
-     * @return
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtUser queryMemberById(Integer id) throws BusinessCheckException {
@@ -583,6 +587,7 @@ public class MemberServiceImpl extends ServiceImpl<MtUserMapper, MtUser> impleme
      * @param  merchantId 商户ID
      * @param  name 会员名称
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtUser queryMemberByName(Integer merchantId, String name) {
@@ -601,6 +606,7 @@ public class MemberServiceImpl extends ServiceImpl<MtUserMapper, MtUser> impleme
      * @param  merchantId
      * @param  openId
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtUser queryMemberByOpenId(Integer merchantId, String openId, JSONObject userInfo) throws BusinessCheckException {
@@ -718,6 +724,7 @@ public class MemberServiceImpl extends ServiceImpl<MtUserMapper, MtUser> impleme
      *
      * @param  id 等级ID
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtUserGrade queryMemberGradeByGradeId(Integer id) {
@@ -731,6 +738,7 @@ public class MemberServiceImpl extends ServiceImpl<MtUserMapper, MtUser> impleme
      * @param  id 会员ID
      * @param  operator 操作人
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     @OperationServiceLog(description = "删除会员信息")

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

@@ -122,7 +122,7 @@ public class OpenGiftServiceImpl extends ServiceImpl<MtOpenGiftMapper, MtOpenGif
     /**
      * 新增开卡赠礼
      *
-     * @param  mtOpenGift
+     * @param  mtOpenGift 赠礼信息
      * @throws BusinessCheckException
      * @return
      */
@@ -152,7 +152,7 @@ public class OpenGiftServiceImpl extends ServiceImpl<MtOpenGiftMapper, MtOpenGif
     /**
      * 根据ID删除数据
      *
-     * @param  id       开卡赠礼ID
+     * @param  id 开卡赠礼ID
      * @param  operator 操作人
      * @throws BusinessCheckException
      * @return

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

@@ -1245,7 +1245,7 @@ public class OrderServiceImpl extends ServiceImpl<MtOrderMapper, MtOrder> implem
     /**
      * 更新订单
      *
-     * @param mtOrder
+     * @param mtOrder 订单信息
      * @return
      * */
     @Override

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

@@ -57,7 +57,7 @@ public class SettingServiceImpl extends ServiceImpl<MtSettingMapper, MtSetting>
     /**
      * 保存配置
      *
-     * @param  mtSetting
+     * @param  mtSetting 配置参数
      * @throws BusinessCheckException
      * @return
      */

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

@@ -86,7 +86,7 @@ public class SmsTemplateServiceImpl extends ServiceImpl<MtSmsTemplateMapper, MtS
     /**
      * 保存模板信息
      *
-     * @param mtSmsTemplateDto
+     * @param mtSmsTemplateDto 短信模板
      * @return
      */
     @Override
@@ -125,6 +125,7 @@ public class SmsTemplateServiceImpl extends ServiceImpl<MtSmsTemplateMapper, MtS
      *
      * @param id 模板ID
      * @param operator 操作人
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)

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

@@ -132,7 +132,8 @@ public class UserGradeServiceImpl extends ServiceImpl<MtUserGradeMapper, MtUserG
     /**
      * 修改会员等级
      *
-     * @param mtUserGrade
+     * @param mtUserGrade 会员等级
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -157,6 +158,7 @@ public class UserGradeServiceImpl extends ServiceImpl<MtUserGradeMapper, MtUserG
      *
      * @param id ID
      * @param operator 操作人
+     * @return
      */
     @Override
     @Transactional(rollbackFor = Exception.class)
@@ -174,7 +176,7 @@ public class UserGradeServiceImpl extends ServiceImpl<MtUserGradeMapper, MtUserG
     /**
      * 获取默认的会员等级
      *
-     * @param merchantId
+     * @param merchantId 商户ID
      * @return
      */
     @Override

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

@@ -31,6 +31,7 @@ public class VerifyCodeServiceImpl extends ServiceImpl<MtVerifyCodeMapper, MtVer
      * @param mobile
      * @param verifyCode
      * @throws BusinessCheckException
+     * @return
      */
     public MtVerifyCode addVerifyCode(String mobile, String verifyCode, Integer expireSecond) {
         if (null == expireSecond || expireSecond<0) {
@@ -78,6 +79,7 @@ public class VerifyCodeServiceImpl extends ServiceImpl<MtVerifyCodeMapper, MtVer
      * @param id
      * @param validFlag
      * @throws BusinessCheckException
+     * @return
      */
     @Override
     public MtVerifyCode updateValidFlag(Long id, String validFlag)  throws BusinessCheckException {
@@ -101,6 +103,7 @@ public class VerifyCodeServiceImpl extends ServiceImpl<MtVerifyCodeMapper, MtVer
      * @param mobile 电话号码
      * @param verifyCode 验证码
      * @throws BusinessCheckException
+     * @return
      */
     public MtVerifyCode checkVerifyCode(String mobile, String verifyCode) {
         MtVerifyCode reVerifyCode;