🎨 规范注释风格

chenlei65368 · Oct 25, 2020 · f56236a · f56236a
1 parent ca87bd0
commit f56236a
Show file tree

Hide file tree

Showing 471 changed files with 1,183 additions and 3,442 deletions.
diff --git a/demo-activiti/src/main/java/com/xkcoding/activiti/SpringBootDemoActivitiApplication.java b/demo-activiti/src/main/java/com/xkcoding/activiti/SpringBootDemoActivitiApplication.java
@@ -8,13 +8,8 @@
  * 启动器
  * </p>
  *
- * @package: com.xkcoding.activiti
- * @description: 启动器
- * @author: yangkai.shen
- * @date: Created in 2019-03-31 22:24
- * @copyright: Copyright (c) 2019
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2019-03-31 22:24
  */
 @SpringBootApplication
 public class SpringBootDemoActivitiApplication {

diff --git a/demo-activiti/src/main/java/com/xkcoding/activiti/config/SecurityConfiguration.java b/demo-activiti/src/main/java/com/xkcoding/activiti/config/SecurityConfiguration.java
@@ -21,13 +21,8 @@
  * 安全配置类
  * </p>
  *
- * @package: com.xkcoding.activiti.config
- * @description: 安全配置类
- * @author: yangkai.shen
- * @date: Created in 2019-07-01 18:40
- * @copyright: Copyright (c) 2019
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2019-07-01 18:40
  */
 @Slf4j
 @Configuration

diff --git a/demo-activiti/src/main/java/com/xkcoding/activiti/util/SecurityUtil.java b/demo-activiti/src/main/java/com/xkcoding/activiti/util/SecurityUtil.java
@@ -17,13 +17,8 @@
  * 认证工具
  * </p>
  *
- * @package: com.xkcoding.activiti.util
- * @description: 认证工具
- * @author: yangkai.shen
- * @date: Created in 2019-07-01 18:38
- * @copyright: Copyright (c) 2019
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2019-07-01 18:38
  */
 @Component
 @RequiredArgsConstructor(onConstructor_ = @Autowired)

diff --git a/demo-actuator/src/main/java/com/xkcoding/actuator/SpringBootDemoActuatorApplication.java b/demo-actuator/src/main/java/com/xkcoding/actuator/SpringBootDemoActuatorApplication.java
@@ -8,13 +8,8 @@
  * 启动类
  * </p>
  *
- * @package: com.xkcoding.actuator
- * @description: 启动类
- * @author: yangkai.shen
- * @date: Created in 2018/9/29 2:27 PM
- * @copyright: Copyright (c)2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-9-29 14:27
  */
 @SpringBootApplication
 public class SpringBootDemoActuatorApplication {

diff --git a/...-client/src/main/java/com/xkcoding/admin/client/SpringBootDemoAdminClientApplication.java b/...-client/src/main/java/com/xkcoding/admin/client/SpringBootDemoAdminClientApplication.java
@@ -8,13 +8,8 @@
  * 启动类
  * </p>
  *
- * @package: com.xkcoding.admin.client
- * @description: 启动类
- * @author: yangkai.shen
- * @date: Created in 2018/10/8 2:16 PM
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-10-8 14:16
  */
 @SpringBootApplication
 public class SpringBootDemoAdminClientApplication {

diff --git a/...dmin/admin-client/src/main/java/com/xkcoding/admin/client/controller/IndexController.java b/...dmin/admin-client/src/main/java/com/xkcoding/admin/client/controller/IndexController.java
@@ -8,13 +8,8 @@
  * 首页
  * </p>
  *
- * @package: com.xkcoding.admin.client.controller
- * @description: 首页
- * @author: yangkai.shen
- * @date: Created in 2018/10/8 2:15 PM
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-10-08 14:15
  */
 @RestController
 public class IndexController {

diff --git a/demo-admin/admin-server/README.md b/demo-admin/admin-server/README.md
@@ -68,13 +68,8 @@
  * 启动类
  * </p>
  *
- * @package: com.xkcoding.admin.server
- * @description: 启动类
- * @author: yangkai.shen
- * @date: Created in 2018/10/8 2:08 PM
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-10-08 14:08
  */
 @EnableAdminServer
 @SpringBootApplication

diff --git a/...-server/src/main/java/com/xkcoding/admin/server/SpringBootDemoAdminServerApplication.java b/...-server/src/main/java/com/xkcoding/admin/server/SpringBootDemoAdminServerApplication.java
@@ -9,13 +9,8 @@
  * 启动类
  * </p>
  *
- * @package: com.xkcoding.admin.server
- * @description: 启动类
- * @author: yangkai.shen
- * @date: Created in 2018/10/8 2:08 PM
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-10-08 14:08
  */
 @EnableAdminServer
 @SpringBootApplication

diff --git a/demo-async/README.md b/demo-async/README.md
@@ -90,13 +90,8 @@ spring:
  * 启动器
  * </p>
  *
- * @package: com.xkcoding.async
- * @description: 启动器
- * @author: yangkai.shen
- * @date: Created in 2018-12-29 10:28
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-12-29 10:28
  */
 @EnableAsync
 @SpringBootApplication
@@ -117,13 +112,8 @@ public class SpringBootDemoAsyncApplication {
  * 任务工厂
  * </p>
  *
- * @package: com.xkcoding.async.task
- * @description: 任务工厂
- * @author: yangkai.shen
- * @date: Created in 2018-12-29 10:37
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-12-29 10:37
  */
 @Component
 @Slf4j
@@ -193,13 +183,8 @@ public class TaskFactory {
  * 测试任务
  * </p>
  *
- * @package: com.xkcoding.async.task
- * @description: 测试任务
- * @author: yangkai.shen
- * @date: Created in 2018-12-29 10:49
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-12-29 10:49
  */
 @Slf4j
 public class TaskFactoryTest extends SpringBootDemoAsyncApplicationTests {
@@ -269,4 +254,4 @@ public class TaskFactoryTest extends SpringBootDemoAsyncApplicationTests {
 
 ## 参考
 
-- Spring Boot 异步任务线程池的配置 参考官方文档：https://docs.spring.io/spring-boot/docs/2.1.0.RELEASE/reference/htmlsingle/#boot-features-task-execution-scheduling
+- Spring Boot 异步任务线程池的配置 参考官方文档：https://docs.spring.io/spring-boot/docs/2.1.0.RELEASE/reference/htmlsingle/#boot-features-task-execution-scheduling
diff --git a/demo-async/src/main/java/com/xkcoding/async/SpringBootDemoAsyncApplication.java b/demo-async/src/main/java/com/xkcoding/async/SpringBootDemoAsyncApplication.java
@@ -9,13 +9,8 @@
  * 启动器
  * </p>
  *
- * @package: com.xkcoding.async
- * @description: 启动器
- * @author: yangkai.shen
- * @date: Created in 2018-12-29 10:28
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-12-29 10:28
  */
 @EnableAsync
 @SpringBootApplication

diff --git a/demo-async/src/main/java/com/xkcoding/async/task/TaskFactory.java b/demo-async/src/main/java/com/xkcoding/async/task/TaskFactory.java
@@ -13,13 +13,8 @@
  * 任务工厂
  * </p>
  *
- * @package: com.xkcoding.async.task
- * @description: 任务工厂
- * @author: yangkai.shen
- * @date: Created in 2018-12-29 10:37
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-12-29 10:37
  */
 @Component
 @Slf4j

diff --git a/demo-async/src/test/java/com/xkcoding/async/task/TaskFactoryTest.java b/demo-async/src/test/java/com/xkcoding/async/task/TaskFactoryTest.java
@@ -13,13 +13,8 @@
  * 测试任务
  * </p>
  *
- * @package: com.xkcoding.async.task
- * @description: 测试任务
- * @author: yangkai.shen
- * @date: Created in 2018-12-29 10:49
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-12-29 10:49
  */
 @Slf4j
 public class TaskFactoryTest extends SpringBootDemoAsyncApplicationTests {
@@ -58,4 +53,4 @@ public void taskTest() throws InterruptedException {
 
         log.info("同步任务全部执行结束，总耗时：{} 毫秒", (end - start));
     }
-}
+}
diff --git a/demo-cache-ehcache/README.md b/demo-cache-ehcache/README.md
@@ -84,13 +84,8 @@
  * 启动类
  * </p>
  *
- * @package: com.xkcoding.cache.ehcache
- * @description: 启动类
- * @author: yangkai.shen
- * @date: Created in 2018/11/16 17:02
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-11-16 17:02
  */
 @SpringBootApplication
 @EnableCaching
@@ -165,13 +160,8 @@ logging:
  * UserService
  * </p>
  *
- * @package: com.xkcoding.cache.ehcache.service.impl
- * @description: UserService
- * @author: yangkai.shen
- * @date: Created in 2018/11/16 16:54
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-11-16 16:54
  */
 @Service
 @Slf4j
@@ -240,13 +230,8 @@ public class UserServiceImpl implements UserService {
  * ehcache缓存测试
  * </p>
  *
- * @package: com.xkcoding.cache.ehcache.service
- * @description: ehcache缓存测试
- * @author: yangkai.shen
- * @date: Created in 2018/11/16 16:58
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-11-16 16:58
  */
 @Slf4j
 public class UserServiceTest extends SpringBootDemoCacheEhcacheApplicationTests {
@@ -298,4 +283,4 @@ public class UserServiceTest extends SpringBootDemoCacheEhcacheApplicationTests
 
 - Ehcache 官网：http://www.ehcache.org/documentation/
 - Spring Boot 官方文档：https://docs.spring.io/spring-boot/docs/2.1.0.RELEASE/reference/htmlsingle/#boot-features-caching-provider-ehcache2
-- 博客：https://juejin.im/post/5b308de9518825748b56ae1d
+- 博客：https://juejin.im/post/5b308de9518825748b56ae1d
diff --git a/...cache/src/main/java/com/xkcoding/cache/ehcache/SpringBootDemoCacheEhcacheApplication.java b/...cache/src/main/java/com/xkcoding/cache/ehcache/SpringBootDemoCacheEhcacheApplication.java
@@ -9,13 +9,8 @@
  * 启动类
  * </p>
  *
- * @package: com.xkcoding.cache.ehcache
- * @description: 启动类
- * @author: yangkai.shen
- * @date: Created in 2018/11/16 17:02
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-11-16 17:02
  */
 @SpringBootApplication
 @EnableCaching

diff --git a/demo-cache-ehcache/src/main/java/com/xkcoding/cache/ehcache/entity/User.java b/demo-cache-ehcache/src/main/java/com/xkcoding/cache/ehcache/entity/User.java
@@ -11,13 +11,8 @@
  * 用户实体
  * </p>
  *
- * @package: com.xkcoding.cache.ehcache.entity
- * @description: 用户实体
- * @author: yangkai.shen
- * @date: Created in 2018/11/16 16:53
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-11-16 16:53
  */
 @Data
 @AllArgsConstructor

diff --git a/demo-cache-ehcache/src/main/java/com/xkcoding/cache/ehcache/service/UserService.java b/demo-cache-ehcache/src/main/java/com/xkcoding/cache/ehcache/service/UserService.java
@@ -7,13 +7,8 @@
  * UserService
  * </p>
  *
- * @package: com.xkcoding.cache.ehcache.service
- * @description: UserService
- * @author: yangkai.shen
- * @date: Created in 2018/11/16 16:53
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-11-16 16:53
  */
 public interface UserService {
     /**

diff --git a/...-cache-ehcache/src/main/java/com/xkcoding/cache/ehcache/service/impl/UserServiceImpl.java b/...-cache-ehcache/src/main/java/com/xkcoding/cache/ehcache/service/impl/UserServiceImpl.java
@@ -16,13 +16,8 @@
  * UserService
  * </p>
  *
- * @package: com.xkcoding.cache.ehcache.service.impl
- * @description: UserService
- * @author: yangkai.shen
- * @date: Created in 2018/11/16 16:54
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-11-16 16:54
  */
 @Service
 @Slf4j

diff --git a/demo-cache-ehcache/src/test/java/com/xkcoding/cache/ehcache/service/UserServiceTest.java b/demo-cache-ehcache/src/test/java/com/xkcoding/cache/ehcache/service/UserServiceTest.java
@@ -11,13 +11,8 @@
  * ehcache缓存测试
  * </p>
  *
- * @package: com.xkcoding.cache.ehcache.service
- * @description: ehcache缓存测试
- * @author: yangkai.shen
- * @date: Created in 2018/11/16 16:58
- * @copyright: Copyright (c) 2018
- * @version: V1.0
- * @modified: yangkai.shen
+ * @author yangkai.shen
+ * @date Created in 2018-11-16 16:58
  */
 @Slf4j
 public class UserServiceTest extends SpringBootDemoCacheEhcacheApplicationTests {
@@ -62,4 +57,4 @@ public void deleteUser() {
         // 删除，查看ehcache是否存在缓存数据
         userService.delete(1L);
     }
-}
+}