Java注释规范(配合EasyYapi使用)
类注释
示例
/**
* 分类名称
* 分类备注/描述
* @module 归属项目
* @author Allen
* @date 2020/6/5 下午2:25
* @copyright 2020 barm Inc. All rights reserved
*/
@RestController
@RequestMapping("/barm")
public class DemoController {
第一行默认是 接口 分类名称
第一行到第一个以@开头的行之前的为 接口描述
请注意规范, 类请明确 @author, @date, @copyright
@module用于分类api , 详情见下文
通过 live templates 配置类注释模板
/**
* TODO
* TODO
* @module TODO
* @author Allen
* @date $date$ $time$
* @copyright 2020 barm Inc. All rights reserved
*/
进入 live templates > 新增group > 添加模板cheader