前言
IDEA 文档插件 Doc View 又更新了新版本,本次更新版本如下:
支持在方法右键菜单选择 Doc Editor 直接编辑文档
- 编辑接口文档名称
- 编辑接口描述
- 编辑字段是否必填
- 编辑字段注释说明
- 点击确定, 会回写到源文件的注释中
支持在 Entity 中通过邮件菜单选择Doc Editor 编辑字段信息
- 编辑字段是否必填
- 编辑字段注释说明
- 点击确定, 会回写到源文件的注释中
- 支持将 Entity 复制为 Json 字符串
- 复制 Json 字符串时, 支持 Entity 中包含对象的转换
- 从 Doc View 预览界面直接跳转到编辑界面
是不是看着挺多的,下面,咱们就了解下具体都是什么吧!
Doc Editor
在方法右键菜单
弹起操作面板,可编辑参数如下:
- 接口名称:默认取方法名,当有注释且注释 tag 为 @docName 时,会取 @docName 对应的名称;
- 接口描述:取注释的描述内容;
- 请求/返回参数:请求返回参数的是否必填、描述。
下面使用动图演示:
在实体类右键菜单
在实体类中右键菜单,其实相当于方法中的请求/返回参数那一部分。
操作面板操作如下:
- 是否必填:将使用注释 tag @required 作为是否必填的标识。当然也支持
javax.validation.constraints
的部分注解; - 描述信息:描述内容为注释内容,修改后会回写到注释中;
- 复制为 Json 字符串,支持多级嵌套。
如果上述内容点击 Copy as Json
会将实体转换为 Json 字符串复制到剪贴板。
直接从预览界面跳转
当打开 Doc View 文档界面时,左下角可以通过编辑按钮跳转到 Doc Editor 界面。
总结
Doc View 本次更新介绍就到这里就结束了,有兴趣的小伙伴,可以自己安装体验。
欢迎小伙伴们提出 Issue 和 PR。
项目地址:https://github.com/liuzhihang...
插件地址:https://plugins.jetbrains.com...
【广告】
为了方便沟通交流,我创建了一个技术交流群,在群里可以交流技术,聊天提问,有兴趣的小伙伴可以通过公众号加我好友,发送进群,我会拉你进群。
PS:事先说好哦,不准发广告。