💡 补充代码注释

src/main/java/cc/ryanc/halo/Application.java

@@ -7,8 +7,12 @@ import org.springframework.cache.annotation.EnableCaching;
 import org.springframework.context.ApplicationContext;
 
 /**
- * @author RYAN0UP
- * SpringBoot启动类
+ * <pre>
+ *     Halo run!
+ * </pre>
+ *
+ * @author : RYAN0UP
+ * @date : 2017/11/14
  */
 @Slf4j
 @SpringBootApplication

src/main/java/cc/ryanc/halo/model/enums/AllowComment.java

@@ -1,6 +1,10 @@
 package cc.ryanc.halo.model.enums;
 
 /**
+ * <pre>
+ *     文章是否允许评论enum
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/7/9
  */

src/main/java/cc/ryanc/halo/model/enums/BackupType.java

@@ -1,6 +1,10 @@
 package cc.ryanc.halo.model.enums;
 
 /**
+ * <pre>
+ *     备份类型enum
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/7/22
  */

src/main/java/cc/ryanc/halo/model/enums/BlogProperties.java

@@ -1,6 +1,10 @@
 package cc.ryanc.halo.model.enums;
 
 /**
+ * <pre>
+ *     常用博客设置enum
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/7/14
  */

src/main/java/cc/ryanc/halo/model/enums/CommentStatus.java

@@ -1,6 +1,10 @@
 package cc.ryanc.halo.model.enums;
 
 /**
+ * <pre>
+ *     评论状态enum
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/7/1
  */

src/main/java/cc/ryanc/halo/model/enums/PostStatus.java

@@ -1,6 +1,10 @@
 package cc.ryanc.halo.model.enums;
 
 /**
+ * <pre>
+ *     文章状态enum
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/7/1
  */

src/main/java/cc/ryanc/halo/model/enums/PostType.java

@@ -1,6 +1,10 @@
 package cc.ryanc.halo.model.enums;
 
 /**
+ * <pre>
+ *     文章类型enum
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/7/1
  */

src/main/java/cc/ryanc/halo/model/enums/QiniuProperties.java

@@ -1,6 +1,10 @@
 package cc.ryanc.halo.model.enums;
 
 /**
+ * <pre>
+ *     七牛配置enum
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/7/14
  */

src/main/java/cc/ryanc/halo/model/enums/ResponseStatus.java

@@ -1,6 +1,10 @@
 package cc.ryanc.halo.model.enums;
 
 /**
+ * <pre>
+ *     请求响应enum
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/7/1
  */

src/main/java/cc/ryanc/halo/model/enums/ResultCode.java

@@ -1,6 +1,10 @@
 package cc.ryanc.halo.model.enums;
 
 /**
+ * <pre>
+ *     返回结果enum
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/7/14
  */

src/main/java/cc/ryanc/halo/model/enums/TrueFalse.java

@@ -1,6 +1,10 @@
 package cc.ryanc.halo.model.enums;
 
 /**
+ * <pre>
+ *     true or false enum
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/7/16
  */

src/main/java/cc/ryanc/halo/service/AttachmentService.java

@@ -8,6 +8,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     附件业务逻辑接口
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/10
  */

src/main/java/cc/ryanc/halo/service/CategoryService.java

@@ -6,6 +6,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     分类业务逻辑接口
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/11/30
  */

src/main/java/cc/ryanc/halo/service/CommentService.java

@@ -9,6 +9,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     评论业务逻辑接口
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/22
  */

src/main/java/cc/ryanc/halo/service/GalleryService.java

@@ -8,6 +8,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     图库业务逻辑接口
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/2/26
  */

src/main/java/cc/ryanc/halo/service/LinkService.java

@@ -6,6 +6,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     友情链接业务逻辑接口
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/11/14
  */

src/main/java/cc/ryanc/halo/service/LogsService.java

@@ -8,6 +8,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     日志业务逻辑接口
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/19
  */

src/main/java/cc/ryanc/halo/service/MailService.java

@@ -3,6 +3,10 @@ package cc.ryanc.halo.service;
 import java.util.Map;
 
 /**
+ * <pre>
+ *     邮件发送业务逻辑接口
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/23
  */

src/main/java/cc/ryanc/halo/service/MenuService.java

@@ -6,6 +6,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     菜单业务逻辑接口
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/24
  */

src/main/java/cc/ryanc/halo/service/OptionsService.java

@@ -5,6 +5,10 @@ import cc.ryanc.halo.model.domain.Options;
 import java.util.Map;
 
 /**
+ * <pre>
+ *     系统设置业务逻辑接口
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/11/14
  */

src/main/java/cc/ryanc/halo/service/PostService.java

@@ -12,6 +12,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     文章/页面业务逻辑接口
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/11/14
  */

src/main/java/cc/ryanc/halo/service/TagService.java

@@ -6,6 +6,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     标签业务逻辑接口
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/12
  */

src/main/java/cc/ryanc/halo/service/UserService.java

@@ -5,6 +5,10 @@ import cc.ryanc.halo.model.domain.User;
 import java.util.Date;
 
 /**
+ * <pre>
+ *     用户业务逻辑接口
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/11/14
  */

src/main/java/cc/ryanc/halo/service/impl/AttachmentServiceImpl.java

@@ -14,6 +14,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     附件业务逻辑实现类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/10
  */

src/main/java/cc/ryanc/halo/service/impl/CategoryServiceImpl.java

@@ -11,6 +11,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     分类业务逻辑实现类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/11/30
  */

src/main/java/cc/ryanc/halo/service/impl/CommentServiceImpl.java

@@ -16,6 +16,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     评论业务逻辑实现类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/22
  */

src/main/java/cc/ryanc/halo/service/impl/GalleryServiceImpl.java

@@ -14,6 +14,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     图库业务逻辑实现类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/2/26
  */

src/main/java/cc/ryanc/halo/service/impl/LinkServiceImpl.java

@@ -12,6 +12,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     友情链接业务逻辑实现类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/11/14
  */

src/main/java/cc/ryanc/halo/service/impl/LogsServiceImpl.java

@@ -12,6 +12,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     日志业务逻辑实现类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/19
  */

src/main/java/cc/ryanc/halo/service/impl/MailServiceImpl.java

@@ -15,6 +15,10 @@ import java.io.File;
 import java.util.Map;
 
 /**
+ * <pre>
+ *     邮件发送业务逻辑实现类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/23
  */

src/main/java/cc/ryanc/halo/service/impl/MenuServiceImpl.java

@@ -12,6 +12,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     菜单业务逻辑实现类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/24
  */

src/main/java/cc/ryanc/halo/service/impl/OptionsServiceImpl.java

@@ -12,6 +12,10 @@ import java.util.List;
 import java.util.Map;
 
 /**
+ * <pre>
+ *     系统设置业务逻辑实现类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/11/14
  */

src/main/java/cc/ryanc/halo/service/impl/PostServiceImpl.java

@@ -24,6 +24,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     文章业务逻辑实现类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/11/14
  */

src/main/java/cc/ryanc/halo/service/impl/TagServiceImpl.java

@@ -11,6 +11,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     标签业务逻辑实现类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/12
  */

src/main/java/cc/ryanc/halo/service/impl/UserServiceImpl.java

@@ -11,6 +11,10 @@ import java.util.Date;
 import java.util.List;
 
 /**
+ * <pre>
+ *     用户业务逻辑实现类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/11/14
  */

src/main/java/cc/ryanc/halo/utils/CommentUtil.java

@@ -6,6 +6,10 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
+ * <pre>
+ *     拼装评论
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/7/12
  */

src/main/java/cc/ryanc/halo/web/controller/admin/AdminController.java

@@ -35,6 +35,10 @@ import java.util.Date;
 import java.util.List;
 
 /**
+ * <pre>
+ *     后台首页控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/5
  */

src/main/java/cc/ryanc/halo/web/controller/admin/AttachmentController.java

@@ -35,6 +35,10 @@ import java.util.Optional;
 import java.util.Random;
 
 /**
+ * <pre>
+ *     后台附件控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/19
  */

src/main/java/cc/ryanc/halo/web/controller/admin/BackupController.java

@@ -31,6 +31,10 @@ import java.util.List;
 import java.util.Map;
 
 /**
+ * <pre>
+ *     后台备份控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/21
  */

src/main/java/cc/ryanc/halo/web/controller/admin/CategoryController.java

@@ -12,6 +12,10 @@ import javax.websocket.server.PathParam;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     后台分类管理控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/10
  */

src/main/java/cc/ryanc/halo/web/controller/admin/CommentController.java

@@ -39,6 +39,10 @@ import java.util.HashMap;
 import java.util.Map;
 
 /**
+ * <pre>
+ *     后台评论管理控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/10
  */

src/main/java/cc/ryanc/halo/web/controller/admin/MenuController.java

@@ -11,6 +11,10 @@ import org.springframework.web.bind.annotation.*;
 import javax.websocket.server.PathParam;
 
 /**
+ * <pre>
+ *     后台菜单管理控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/30
  */

src/main/java/cc/ryanc/halo/web/controller/admin/OptionController.java

@@ -13,6 +13,10 @@ import org.springframework.web.bind.annotation.*;
 import java.util.Map;
 
 /**
+ * <pre>
+ *     后台设置选项控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/13
  */

src/main/java/cc/ryanc/halo/web/controller/admin/PageController.java

@@ -30,6 +30,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     后台页面管理控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/10
  */

src/main/java/cc/ryanc/halo/web/controller/admin/PostController.java

@@ -36,6 +36,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     后台文章管理控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/10
  */

src/main/java/cc/ryanc/halo/web/controller/admin/TagController.java

@@ -11,6 +11,10 @@ import org.springframework.web.bind.annotation.*;
 import javax.websocket.server.PathParam;
 
 /**
+ * <pre>
+ *     后台标签管理控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/10
  */

src/main/java/cc/ryanc/halo/web/controller/admin/ThemeController.java

@@ -32,6 +32,10 @@ import java.io.File;
 import java.util.List;
 
 /**
+ * <pre>
+ *     后台主题管理控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/16
  */

src/main/java/cc/ryanc/halo/web/controller/admin/UserController.java

@@ -17,6 +17,10 @@ import javax.servlet.http.HttpSession;
 import javax.validation.Valid;
 
 /**
+ * <pre>
+ *     后台用户管理控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/24
  */

src/main/java/cc/ryanc/halo/web/controller/api/ApiArchivesController.java

@@ -12,6 +12,10 @@ import org.springframework.web.bind.annotation.RestController;
 import java.util.List;
 
 /**
+ * <pre>
+ *     文章归档API
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/6/6
  */

src/main/java/cc/ryanc/halo/web/controller/api/ApiCategoryController.java

@@ -13,6 +13,10 @@ import org.springframework.web.bind.annotation.RestController;
 import java.util.List;
 
 /**
+ * <pre>
+ *     文章分类API
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/6/6
  */

src/main/java/cc/ryanc/halo/web/controller/api/ApiCommentController.java

@@ -6,6 +6,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 /**
+ * <pre>
+ *     评论API
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/6/6
  */

src/main/java/cc/ryanc/halo/web/controller/api/ApiGalleryController.java

@@ -14,6 +14,10 @@ import java.util.List;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     图库API
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/6/6
  */

src/main/java/cc/ryanc/halo/web/controller/api/ApiLinkController.java

@@ -12,6 +12,10 @@ import org.springframework.web.bind.annotation.RestController;
 import java.util.List;
 
 /**
+ * <pre>
+ *     友情链接API
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/6/6
  */

src/main/java/cc/ryanc/halo/web/controller/api/ApiMenuController.java

@@ -12,6 +12,10 @@ import org.springframework.web.bind.annotation.RestController;
 import java.util.List;
 
 /**
+ * <pre>
+ *     菜单API
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/6/6
  */

src/main/java/cc/ryanc/halo/web/controller/api/ApiOptionController.java

@@ -13,6 +13,10 @@ import org.springframework.web.bind.annotation.RestController;
 import java.util.Map;
 
 /**
+ * <pre>
+ *     系统设置API
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/7/19
  */

src/main/java/cc/ryanc/halo/web/controller/api/ApiPageController.java

@@ -12,6 +12,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 /**
+ * <pre>
+ *     页面API
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/6/6
  */

src/main/java/cc/ryanc/halo/web/controller/api/ApiPostController.java

@@ -22,6 +22,10 @@ import org.springframework.web.bind.annotation.RestController;
 import java.util.List;
 
 /**
+ * <pre>
+ *     文章API
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/6/6
  */

src/main/java/cc/ryanc/halo/web/controller/api/ApiTagController.java

@@ -13,6 +13,10 @@ import org.springframework.web.bind.annotation.RestController;
 import java.util.List;
 
 /**
+ * <pre>
+ *     标签API
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/6/6
  */

src/main/java/cc/ryanc/halo/web/controller/api/ApiUserController.java

@@ -10,6 +10,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 /**
+ * <pre>
+ *     用户API
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/6/6
  */

src/main/java/cc/ryanc/halo/web/controller/core/BaseController.java

@@ -1,6 +1,10 @@
 package cc.ryanc.halo.web.controller.core;
 
 /**
+ * <pre>
+ *     Controller抽象类
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/15
  */

src/main/java/cc/ryanc/halo/web/controller/core/CommonController.java

@@ -8,6 +8,10 @@ import org.springframework.web.bind.annotation.GetMapping;
 import javax.servlet.http.HttpServletRequest;
 
 /**
+ * <pre>
+ *     错误页面控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/26
  */

src/main/java/cc/ryanc/halo/web/controller/core/InstallController.java

@@ -24,6 +24,10 @@ import java.util.ArrayList;
 import java.util.List;
 
 /**
+ * <pre>
+ *     博客初始化控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/28
  */

src/main/java/cc/ryanc/halo/web/controller/front/FrontArchiveController.java

@@ -25,6 +25,10 @@ import java.util.Date;
 import java.util.List;
 
 /**
+ * <pre>
+ *     前台文章归档控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/4/26
  */

src/main/java/cc/ryanc/halo/web/controller/front/FrontCategoryController.java

@@ -22,6 +22,10 @@ import org.springframework.web.bind.annotation.RequestMapping;
 import java.util.List;
 
 /**
+ * <pre>
+ *     前台文章分类控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/4/26
  */

src/main/java/cc/ryanc/halo/web/controller/front/FrontCommentController.java

@@ -36,6 +36,10 @@ import java.util.Map;
 import java.util.Optional;
 
 /**
+ * <pre>
+ *     前台评论控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/4/26
  */

src/main/java/cc/ryanc/halo/web/controller/front/FrontIndexController.java

@@ -23,6 +23,10 @@ import javax.websocket.server.PathParam;
 import java.util.List;
 
 /**
+ * <pre>
+ *     前台首页控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/4/26
  */

src/main/java/cc/ryanc/halo/web/controller/front/FrontOthersController.java

@@ -18,6 +18,10 @@ import org.springframework.web.bind.annotation.ResponseBody;
 import java.util.List;
 
 /**
+ * <pre>
+ *     sitemap，rss页面控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/4/26
  */

src/main/java/cc/ryanc/halo/web/controller/front/FrontPageController.java

@@ -23,6 +23,10 @@ import org.springframework.web.bind.annotation.PathVariable;
 import java.util.List;
 
 /**
+ * <pre>
+ *     前台内置页面，自定义页面控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/4/26
  */

src/main/java/cc/ryanc/halo/web/controller/front/FrontTagController.java

@@ -20,6 +20,10 @@ import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 
 /**
+ * <pre>
+ *     前台标签控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/4/26
  */

src/main/java/cc/ryanc/halo/web/interceptor/ApiInterceptor.java

@@ -12,6 +12,10 @@ import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 /**
+ * <pre>
+ *     API接口拦截器，用户可自己选择关闭或者开启
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/6/28
  */

src/main/java/cc/ryanc/halo/web/interceptor/InstallInterceptor.java

@@ -12,6 +12,10 @@ import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 /**
+ * <pre>
+ *     博客初始化拦截器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2018/1/28
  */

src/main/java/cc/ryanc/halo/web/interceptor/LoginInterceptor.java

@@ -9,6 +9,10 @@ import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 /**
+ * <pre>
+ *     后台登录控制器
+ * </pre>
+ *
  * @author : RYAN0UP
  * @date : 2017/12/13
  */