Skip to content

Commit f56236a

Browse files
committed
🎨 规范注释风格
1 parent ca87bd0 commit f56236a

File tree

471 files changed

+1183
-3442
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

471 files changed

+1183
-3442
lines changed

demo-activiti/src/main/java/com/xkcoding/activiti/SpringBootDemoActivitiApplication.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,8 @@
88
* 启动器
99
* </p>
1010
*
11-
* @package: com.xkcoding.activiti
12-
* @description: 启动器
13-
* @author: yangkai.shen
14-
* @date: Created in 2019-03-31 22:24
15-
* @copyright: Copyright (c) 2019
16-
* @version: V1.0
17-
* @modified: yangkai.shen
11+
* @author yangkai.shen
12+
* @date Created in 2019-03-31 22:24
1813
*/
1914
@SpringBootApplication
2015
public class SpringBootDemoActivitiApplication {

demo-activiti/src/main/java/com/xkcoding/activiti/config/SecurityConfiguration.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,8 @@
2121
* 安全配置类
2222
* </p>
2323
*
24-
* @package: com.xkcoding.activiti.config
25-
* @description: 安全配置类
26-
* @author: yangkai.shen
27-
* @date: Created in 2019-07-01 18:40
28-
* @copyright: Copyright (c) 2019
29-
* @version: V1.0
30-
* @modified: yangkai.shen
24+
* @author yangkai.shen
25+
* @date Created in 2019-07-01 18:40
3126
*/
3227
@Slf4j
3328
@Configuration

demo-activiti/src/main/java/com/xkcoding/activiti/util/SecurityUtil.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,8 @@
1717
* 认证工具
1818
* </p>
1919
*
20-
* @package: com.xkcoding.activiti.util
21-
* @description: 认证工具
22-
* @author: yangkai.shen
23-
* @date: Created in 2019-07-01 18:38
24-
* @copyright: Copyright (c) 2019
25-
* @version: V1.0
26-
* @modified: yangkai.shen
20+
* @author yangkai.shen
21+
* @date Created in 2019-07-01 18:38
2722
*/
2823
@Component
2924
@RequiredArgsConstructor(onConstructor_ = @Autowired)

demo-actuator/src/main/java/com/xkcoding/actuator/SpringBootDemoActuatorApplication.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,8 @@
88
* 启动类
99
* </p>
1010
*
11-
* @package: com.xkcoding.actuator
12-
* @description: 启动类
13-
* @author: yangkai.shen
14-
* @date: Created in 2018/9/29 2:27 PM
15-
* @copyright: Copyright (c)2018
16-
* @version: V1.0
17-
* @modified: yangkai.shen
11+
* @author yangkai.shen
12+
* @date Created in 2018-9-29 14:27
1813
*/
1914
@SpringBootApplication
2015
public class SpringBootDemoActuatorApplication {

demo-admin/admin-client/src/main/java/com/xkcoding/admin/client/SpringBootDemoAdminClientApplication.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,8 @@
88
* 启动类
99
* </p>
1010
*
11-
* @package: com.xkcoding.admin.client
12-
* @description: 启动类
13-
* @author: yangkai.shen
14-
* @date: Created in 2018/10/8 2:16 PM
15-
* @copyright: Copyright (c) 2018
16-
* @version: V1.0
17-
* @modified: yangkai.shen
11+
* @author yangkai.shen
12+
* @date Created in 2018-10-8 14:16
1813
*/
1914
@SpringBootApplication
2015
public class SpringBootDemoAdminClientApplication {

demo-admin/admin-client/src/main/java/com/xkcoding/admin/client/controller/IndexController.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,8 @@
88
* 首页
99
* </p>
1010
*
11-
* @package: com.xkcoding.admin.client.controller
12-
* @description: 首页
13-
* @author: yangkai.shen
14-
* @date: Created in 2018/10/8 2:15 PM
15-
* @copyright: Copyright (c) 2018
16-
* @version: V1.0
17-
* @modified: yangkai.shen
11+
* @author yangkai.shen
12+
* @date Created in 2018-10-08 14:15
1813
*/
1914
@RestController
2015
public class IndexController {

demo-admin/admin-server/README.md

+2-7
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,8 @@
6868
* 启动类
6969
* </p>
7070
*
71-
* @package: com.xkcoding.admin.server
72-
* @description: 启动类
73-
* @author: yangkai.shen
74-
* @date: Created in 2018/10/8 2:08 PM
75-
* @copyright: Copyright (c) 2018
76-
* @version: V1.0
77-
* @modified: yangkai.shen
71+
* @author yangkai.shen
72+
* @date Created in 2018-10-08 14:08
7873
*/
7974
@EnableAdminServer
8075
@SpringBootApplication

demo-admin/admin-server/src/main/java/com/xkcoding/admin/server/SpringBootDemoAdminServerApplication.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,8 @@
99
* 启动类
1010
* </p>
1111
*
12-
* @package: com.xkcoding.admin.server
13-
* @description: 启动类
14-
* @author: yangkai.shen
15-
* @date: Created in 2018/10/8 2:08 PM
16-
* @copyright: Copyright (c) 2018
17-
* @version: V1.0
18-
* @modified: yangkai.shen
12+
* @author yangkai.shen
13+
* @date Created in 2018-10-08 14:08
1914
*/
2015
@EnableAdminServer
2116
@SpringBootApplication

demo-async/README.md

+7-22
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,8 @@ spring:
9090
* 启动器
9191
* </p>
9292
*
93-
* @package: com.xkcoding.async
94-
* @description: 启动器
95-
* @author: yangkai.shen
96-
* @date: Created in 2018-12-29 10:28
97-
* @copyright: Copyright (c) 2018
98-
* @version: V1.0
99-
* @modified: yangkai.shen
93+
* @author yangkai.shen
94+
* @date Created in 2018-12-29 10:28
10095
*/
10196
@EnableAsync
10297
@SpringBootApplication
@@ -117,13 +112,8 @@ public class SpringBootDemoAsyncApplication {
117112
* 任务工厂
118113
* </p>
119114
*
120-
* @package: com.xkcoding.async.task
121-
* @description: 任务工厂
122-
* @author: yangkai.shen
123-
* @date: Created in 2018-12-29 10:37
124-
* @copyright: Copyright (c) 2018
125-
* @version: V1.0
126-
* @modified: yangkai.shen
115+
* @author yangkai.shen
116+
* @date Created in 2018-12-29 10:37
127117
*/
128118
@Component
129119
@Slf4j
@@ -193,13 +183,8 @@ public class TaskFactory {
193183
* 测试任务
194184
* </p>
195185
*
196-
* @package: com.xkcoding.async.task
197-
* @description: 测试任务
198-
* @author: yangkai.shen
199-
* @date: Created in 2018-12-29 10:49
200-
* @copyright: Copyright (c) 2018
201-
* @version: V1.0
202-
* @modified: yangkai.shen
186+
* @author yangkai.shen
187+
* @date Created in 2018-12-29 10:49
203188
*/
204189
@Slf4j
205190
public class TaskFactoryTest extends SpringBootDemoAsyncApplicationTests {
@@ -269,4 +254,4 @@ public class TaskFactoryTest extends SpringBootDemoAsyncApplicationTests {
269254

270255
## 参考
271256

272-
- Spring Boot 异步任务线程池的配置 参考官方文档:https://docs.spring.io/spring-boot/docs/2.1.0.RELEASE/reference/htmlsingle/#boot-features-task-execution-scheduling
257+
- Spring Boot 异步任务线程池的配置 参考官方文档:https://docs.spring.io/spring-boot/docs/2.1.0.RELEASE/reference/htmlsingle/#boot-features-task-execution-scheduling

demo-async/src/main/java/com/xkcoding/async/SpringBootDemoAsyncApplication.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,8 @@
99
* 启动器
1010
* </p>
1111
*
12-
* @package: com.xkcoding.async
13-
* @description: 启动器
14-
* @author: yangkai.shen
15-
* @date: Created in 2018-12-29 10:28
16-
* @copyright: Copyright (c) 2018
17-
* @version: V1.0
18-
* @modified: yangkai.shen
12+
* @author yangkai.shen
13+
* @date Created in 2018-12-29 10:28
1914
*/
2015
@EnableAsync
2116
@SpringBootApplication

demo-async/src/main/java/com/xkcoding/async/task/TaskFactory.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,8 @@
1313
* 任务工厂
1414
* </p>
1515
*
16-
* @package: com.xkcoding.async.task
17-
* @description: 任务工厂
18-
* @author: yangkai.shen
19-
* @date: Created in 2018-12-29 10:37
20-
* @copyright: Copyright (c) 2018
21-
* @version: V1.0
22-
* @modified: yangkai.shen
16+
* @author yangkai.shen
17+
* @date Created in 2018-12-29 10:37
2318
*/
2419
@Component
2520
@Slf4j

demo-async/src/test/java/com/xkcoding/async/task/TaskFactoryTest.java

+3-8
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,8 @@
1313
* 测试任务
1414
* </p>
1515
*
16-
* @package: com.xkcoding.async.task
17-
* @description: 测试任务
18-
* @author: yangkai.shen
19-
* @date: Created in 2018-12-29 10:49
20-
* @copyright: Copyright (c) 2018
21-
* @version: V1.0
22-
* @modified: yangkai.shen
16+
* @author yangkai.shen
17+
* @date Created in 2018-12-29 10:49
2318
*/
2419
@Slf4j
2520
public class TaskFactoryTest extends SpringBootDemoAsyncApplicationTests {
@@ -58,4 +53,4 @@ public void taskTest() throws InterruptedException {
5853

5954
log.info("同步任务全部执行结束,总耗时:{} 毫秒", (end - start));
6055
}
61-
}
56+
}

demo-cache-ehcache/README.md

+7-22
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,8 @@
8484
* 启动类
8585
* </p>
8686
*
87-
* @package: com.xkcoding.cache.ehcache
88-
* @description: 启动类
89-
* @author: yangkai.shen
90-
* @date: Created in 2018/11/16 17:02
91-
* @copyright: Copyright (c) 2018
92-
* @version: V1.0
93-
* @modified: yangkai.shen
87+
* @author yangkai.shen
88+
* @date Created in 2018-11-16 17:02
9489
*/
9590
@SpringBootApplication
9691
@EnableCaching
@@ -165,13 +160,8 @@ logging:
165160
* UserService
166161
* </p>
167162
*
168-
* @package: com.xkcoding.cache.ehcache.service.impl
169-
* @description: UserService
170-
* @author: yangkai.shen
171-
* @date: Created in 2018/11/16 16:54
172-
* @copyright: Copyright (c) 2018
173-
* @version: V1.0
174-
* @modified: yangkai.shen
163+
* @author yangkai.shen
164+
* @date Created in 2018-11-16 16:54
175165
*/
176166
@Service
177167
@Slf4j
@@ -240,13 +230,8 @@ public class UserServiceImpl implements UserService {
240230
* ehcache缓存测试
241231
* </p>
242232
*
243-
* @package: com.xkcoding.cache.ehcache.service
244-
* @description: ehcache缓存测试
245-
* @author: yangkai.shen
246-
* @date: Created in 2018/11/16 16:58
247-
* @copyright: Copyright (c) 2018
248-
* @version: V1.0
249-
* @modified: yangkai.shen
233+
* @author yangkai.shen
234+
* @date Created in 2018-11-16 16:58
250235
*/
251236
@Slf4j
252237
public class UserServiceTest extends SpringBootDemoCacheEhcacheApplicationTests {
@@ -298,4 +283,4 @@ public class UserServiceTest extends SpringBootDemoCacheEhcacheApplicationTests
298283

299284
- Ehcache 官网:http://www.ehcache.org/documentation/
300285
- Spring Boot 官方文档:https://docs.spring.io/spring-boot/docs/2.1.0.RELEASE/reference/htmlsingle/#boot-features-caching-provider-ehcache2
301-
- 博客:https://juejin.im/post/5b308de9518825748b56ae1d
286+
- 博客:https://juejin.im/post/5b308de9518825748b56ae1d

demo-cache-ehcache/src/main/java/com/xkcoding/cache/ehcache/SpringBootDemoCacheEhcacheApplication.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,8 @@
99
* 启动类
1010
* </p>
1111
*
12-
* @package: com.xkcoding.cache.ehcache
13-
* @description: 启动类
14-
* @author: yangkai.shen
15-
* @date: Created in 2018/11/16 17:02
16-
* @copyright: Copyright (c) 2018
17-
* @version: V1.0
18-
* @modified: yangkai.shen
12+
* @author yangkai.shen
13+
* @date Created in 2018-11-16 17:02
1914
*/
2015
@SpringBootApplication
2116
@EnableCaching

demo-cache-ehcache/src/main/java/com/xkcoding/cache/ehcache/entity/User.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,8 @@
1111
* 用户实体
1212
* </p>
1313
*
14-
* @package: com.xkcoding.cache.ehcache.entity
15-
* @description: 用户实体
16-
* @author: yangkai.shen
17-
* @date: Created in 2018/11/16 16:53
18-
* @copyright: Copyright (c) 2018
19-
* @version: V1.0
20-
* @modified: yangkai.shen
14+
* @author yangkai.shen
15+
* @date Created in 2018-11-16 16:53
2116
*/
2217
@Data
2318
@AllArgsConstructor

demo-cache-ehcache/src/main/java/com/xkcoding/cache/ehcache/service/UserService.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,8 @@
77
* UserService
88
* </p>
99
*
10-
* @package: com.xkcoding.cache.ehcache.service
11-
* @description: UserService
12-
* @author: yangkai.shen
13-
* @date: Created in 2018/11/16 16:53
14-
* @copyright: Copyright (c) 2018
15-
* @version: V1.0
16-
* @modified: yangkai.shen
10+
* @author yangkai.shen
11+
* @date Created in 2018-11-16 16:53
1712
*/
1813
public interface UserService {
1914
/**

demo-cache-ehcache/src/main/java/com/xkcoding/cache/ehcache/service/impl/UserServiceImpl.java

+2-7
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,8 @@
1616
* UserService
1717
* </p>
1818
*
19-
* @package: com.xkcoding.cache.ehcache.service.impl
20-
* @description: UserService
21-
* @author: yangkai.shen
22-
* @date: Created in 2018/11/16 16:54
23-
* @copyright: Copyright (c) 2018
24-
* @version: V1.0
25-
* @modified: yangkai.shen
19+
* @author yangkai.shen
20+
* @date Created in 2018-11-16 16:54
2621
*/
2722
@Service
2823
@Slf4j

demo-cache-ehcache/src/test/java/com/xkcoding/cache/ehcache/service/UserServiceTest.java

+3-8
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,8 @@
1111
* ehcache缓存测试
1212
* </p>
1313
*
14-
* @package: com.xkcoding.cache.ehcache.service
15-
* @description: ehcache缓存测试
16-
* @author: yangkai.shen
17-
* @date: Created in 2018/11/16 16:58
18-
* @copyright: Copyright (c) 2018
19-
* @version: V1.0
20-
* @modified: yangkai.shen
14+
* @author yangkai.shen
15+
* @date Created in 2018-11-16 16:58
2116
*/
2217
@Slf4j
2318
public class UserServiceTest extends SpringBootDemoCacheEhcacheApplicationTests {
@@ -62,4 +57,4 @@ public void deleteUser() {
6257
// 删除,查看ehcache是否存在缓存数据
6358
userService.delete(1L);
6459
}
65-
}
60+
}

0 commit comments

Comments
 (0)