代码修改

notes-pas/src/main/java/com/zjty/tynotes/pas/entity/Authority.java

@@ -12,6 +12,7 @@ import javax.validation.constraints.NotEmpty;
 /**
  * @Author gwj
  * @create 2020/2/24 13:08
+ * @des 权限类
  */
 @Data
 @AllArgsConstructor
@@ -25,9 +26,9 @@ public class Authority {
     private String id;
 
     @NotEmpty(message = "权限名称不可为空")
-    @ApiModelProperty(value = "权限名称",example = "修改人员")
+    @ApiModelProperty(value = "权限名称",example = "查看任务")
     private String name;
 
-    @ApiModelProperty(value = "权限描述",example = "。。。。")
+    @ApiModelProperty(value = "权限描述",example = "查看任务")
     private String description;
 }

notes-pas/src/main/java/com/zjty/tynotes/pas/entity/Config.java

@@ -13,6 +13,7 @@ import javax.validation.constraints.NotEmpty;
 /**
  * @Author gwj
  * @create 2020/3/1 9:38
+ * @des 基础参数配置类
  */
 @Data
 @AllArgsConstructor
@@ -24,7 +25,6 @@ public class Config {
     @ApiModelProperty(value = "id",example = "1")
     private String id;
 
-
     @NotEmpty(message = "上班时间")
     @ApiModelProperty(value = "上班时间",example = "2019/2/2")
     private String workTime;

notes-pas/src/main/java/com/zjty/tynotes/pas/entity/Day.java

@@ -14,6 +14,7 @@ import java.util.Date;
 /**
  * @Author gwj
  * @create 2020/3/1 10:33
+ * @des 节假日配置类
  */
 @Document(collection = "pas_day")
 @Data

notes-pas/src/main/java/com/zjty/tynotes/pas/entity/Department.java

@@ -15,6 +15,7 @@ import java.util.List;
 
 /**
  * @author mcj
+ * @des 部门类
  */
 @Document(collection = "pas_department")
 @Data

notes-pas/src/main/java/com/zjty/tynotes/pas/entity/Role.java

@@ -17,6 +17,7 @@ import java.util.List;
 /**
  * @Author gwj
  * @create 2020/2/24 10:50
+ * @des 角色类
  */
 @Data
 @AllArgsConstructor

notes-pas/src/main/java/com/zjty/tynotes/pas/entity/RoleAuthority.java

@@ -13,6 +13,7 @@ import javax.validation.constraints.NotNull;
 /**
  * @Author gwj
  * @create 2020/2/28 14:11
+ * @des 角色权限关联类
  */
 @Data
 @AllArgsConstructor

notes-pas/src/main/java/com/zjty/tynotes/pas/entity/User.java

@@ -25,6 +25,7 @@ import java.util.List;
 /**
  * @Author gwj
  * @create 2020/2/24 10:22
+ * @des 用户类
  */
 @Data
 @AllArgsConstructor

notes-pas/src/main/java/com/zjty/tynotes/pas/entity/UserRole.java

@@ -13,6 +13,7 @@ import javax.validation.constraints.NotNull;
 /**
  * @Author gwj
  * @create 2020/2/28 14:11
+ * @des 用户角色关联类
  */
 @Data
 @AllArgsConstructor

notes-pas/src/main/java/com/zjty/tynotes/pas/entity/vo/HolidayRequest.java

@@ -9,12 +9,13 @@ import java.util.Date;
 /**
  * @Author gwj
  * @create 2020/3/1 10:22
+ * @des 任务模块请求数据时的数据格式，一个起始时间，一个结束时间
  */
 @Data
 @AllArgsConstructor
 @NoArgsConstructor
 public class HolidayRequest {
-    private Date startDate;
+    private Date startDate;//起始时间
 
-    private Date endDate;
+    private Date endDate;//结束时间
 }

notes-pas/src/main/java/com/zjty/tynotes/pas/entity/vo/PageRequest.java

@@ -7,6 +7,7 @@ import lombok.NoArgsConstructor;
 /**
  * @Author gwj
  * @create 2020/3/2 11:02
+ * @des 分页请求类
  */
 @Data
 @NoArgsConstructor

notes-pas/src/main/java/com/zjty/tynotes/pas/entity/vo/PageResponse.java

@@ -10,6 +10,7 @@ import java.util.List;
 /**
  * @Author gwj
  * @create 2020/3/2 10:54
+ * @des 分页返回类
  */
 @Data
 @AllArgsConstructor
@@ -41,7 +42,7 @@ public class PageResponse<T> implements Serializable {
 
     /**
      * 设置结果 及总页数
-     * @param rows 分页之后查询到的结果
+     * @param rows 分页之后查询到的结果，(暂时无用)
      */
     public void build(List<T> rows) {
         this.setRows(rows);

notes-pas/src/main/java/com/zjty/tynotes/pas/service/ConfigService.java

@@ -47,7 +47,15 @@ public interface ConfigService {
      */
     List<Day> findHolidaysByMonth(String date);
 
+    /**
+     * 查询基础参数配置
+     * @return
+     */
     Config findConfig();
 
+    /**
+     * 清除所有节假日数据
+     * @return
+     */
     boolean deleteAll();
 }

notes-pas/src/main/java/com/zjty/tynotes/pas/service/IDepartmentService.java

@@ -40,8 +40,18 @@ public interface IDepartmentService {
      */
     List<Department> findList();
 
+    /**
+     * 根据部门id删除部门
+     * @param id
+     * @return
+     */
     boolean deleteDepartment(String id);
 
+    /**
+     * 更新部门信息
+     * @param department
+     * @return
+     */
     boolean updateDepartment(Department department);
 
 

notes-pas/src/main/java/com/zjty/tynotes/pas/service/IRoleService.java

@@ -48,5 +48,10 @@ public interface IRoleService {
      */
     boolean deleteRole(String id);
 
+    /**
+     * 根据部门id查询该部门下的角色
+     * @param id
+     * @return
+     */
     List<Role> findRoleByDepartId(String id);
 }

notes-pas/src/main/java/com/zjty/tynotes/pas/service/IUserService.java

@@ -111,11 +111,15 @@ public interface IUserService {
      */
     List<String> findUsers(String userId);
 
+    /**
+     * 对密码加密(测试数据时用到的接口，目前不要用)
+     * @return
+     */
     Object encryPas();
 
 
     /**
-     * 删除root用户
+     * 删除root用户(不要使用)
      * @return
      */
     Object deleteRoot();

notes-pas/src/main/java/com/zjty/tynotes/pas/service/impl/DepartmentServiceImpl.java

@@ -116,6 +116,10 @@ public class DepartmentServiceImpl implements IDepartmentService {
         return false;
     }
 
+    /**
+     * 递归获得部门树
+     * @param departments
+     */
     public void getDepartments(List<Department> departments) {
         for (Department department : departments) {
             List<Department> departmentList = departmentDao.findAllByParentId(department.getId());

notes-pas/src/main/java/com/zjty/tynotes/pas/service/impl/UserServiceImpl.java

@@ -461,6 +461,11 @@ public class UserServiceImpl implements IUserService {
         return departmentIdList;
     }
 
+    /**
+     * 递归获取所有的部门列表
+     * @param departmentIdList
+     * @param departmentIds
+     */
     public void getDepartments(List<String> departmentIdList,List<String> departmentIds) {
         for (String string : departmentIds) {
             if(departmentIdList.contains(string)){

notes-pas/src/main/java/com/zjty/tynotes/pas/task/Init.java

@@ -19,6 +19,7 @@ import java.util.stream.Collectors;
  * @Author: mcj
  * @Date: 19-4-30 下午2:01
  * @Version 1.0
+ * @des：程序启动初始化的类，查询是否有root用户，若没有，新增root用户
  */
 @Component
 public class Init implements CommandLineRunner {

notes-weekly/src/main/java/com/zjty/tynotes/weekly/subject/service/UserManageService.java

@@ -34,6 +34,11 @@ public interface UserManageService {
      */
     List<Department> findDepartmentList(String id);
 
+    /**
+     * 更改密码
+     * @param user
+     * @return
+     */
     boolean updatePas(User user);
 
     /**

notes-weekly/src/main/java/com/zjty/tynotes/weekly/subject/service/impl/UserManageServiceImpl.java

@@ -218,6 +218,11 @@ public class UserManageServiceImpl implements UserManageService {
         return departments;
     }
 
+    /**
+     * 递归获取该部门下的所有部门列表
+     * @param departmentIdList
+     * @param departmentIds
+     */
     public void getDepartments(List<String> departmentIdList,List<String> departmentIds) {
         for (String string : departmentIds) {
             if(departmentIdList.contains(string)){
@@ -256,6 +261,12 @@ public class UserManageServiceImpl implements UserManageService {
         return false;
     }
 
+    /**
+     * 暂时没有用到
+     * @param des
+     * @param deps
+     * @return
+     */
     private List<Department> findDepartmentList(List<Department> des, List<Department> deps){
         for (Department department : deps) {
             if(!des.contains(department)){