![image.png](https://cdn.nlark.com/yuque/0/2023/png/26851474/1674523315458-6a6e5dd7-d70a-4cea-8023-3ed802ad8069.png#averageHue=%23363a3c&clientId=ub065bf95-bba9-4&from=paste&height=58&id=uc8da9314&originHeight=116&originWidth=1032&originalType=binary&ratio=1&rotation=0&showTitle=false&size=12858&status=done&style=none&taskId=uebf6f0c2-f1b8-4fe5-93d1-5c2bd656705&title=&width=516)
MAC系统推荐快捷键【CMD + \】
![image.png](https://cdn.nlark.com/yuque/0/2023/png/26851474/1674523556516-f67ac520-9d85-4d82-a026-fc2d446c6378.png#averageHue=%232a2e32&clientId=u8bb875fa-d76a-4&from=paste&height=146&id=u1194ae1f&originHeight=292&originWidth=2144&originalType=binary&ratio=1&rotation=0&showTitle=false&size=41612&status=done&style=none&taskId=uf1282d41-c886-4cce-83a6-0d3bfd51d73&title=&width=1072)
介绍
能帮助开发者快速生成类、方法、属性等中文的javadoc/kdoc,此插件能快速生成注释,大多内容是没问题的,但是也会出现生成中文注释不符合预期的情况,需要人工进行修正,总体来看人工修正工作量比较小。
使用
直接使用快捷键生成对应的注释。
类
![image.png](https://cdn.nlark.com/yuque/0/2023/png/26851474/1674523886062-46c20555-9956-47fb-866d-8e7c541eec92.png#averageHue=%23202020&clientId=u8bb875fa-d76a-4&from=paste&height=162&id=u4ef89777&originHeight=324&originWidth=752&originalType=binary&ratio=1&rotation=0&showTitle=false&size=30380&status=done&style=none&taskId=u1059f472-0669-4c0b-9f97-0b3979cc591&title=&width=376)
方法
![image.png](https://cdn.nlark.com/yuque/0/2023/png/26851474/1674523934998-33c2d03e-d726-4cf4-8721-673a7c360645.png#averageHue=%23202020&clientId=u8bb875fa-d76a-4&from=paste&height=211&id=u62b18a6a&originHeight=422&originWidth=980&originalType=binary&ratio=1&rotation=0&showTitle=false&size=39535&status=done&style=none&taskId=ua20cb9a6-0d3f-4ab7-ad09-3a64805c995&title=&width=490)
属性
![image.png](https://cdn.nlark.com/yuque/0/2023/png/26851474/1674524049318-5fa090a4-bc69-4d60-9037-1fb96394c106.png#averageHue=%23202020&clientId=u8bb875fa-d76a-4&from=paste&height=105&id=u36cf2243&originHeight=210&originWidth=684&originalType=binary&ratio=1&rotation=0&showTitle=false&size=16335&status=done&style=none&taskId=u304e8cc1-b7a8-429d-97db-facc143e25c&title=&width=342)
配置
生成内容存在不符合预期的情况,可定制化进行配置,使生成注释更加准确。插件包含Javadoc和Kdoc配置,以下以Javadoc为例。
![image.png](https://cdn.nlark.com/yuque/0/2023/png/26851474/1674525758685-de321e5e-b008-4cb4-b208-674d6fa77fa2.png#averageHue=%232f3236&clientId=u8bb875fa-d76a-4&from=paste&height=407&id=ube8a22c0&originHeight=814&originWidth=2748&originalType=binary&ratio=1&rotation=0&showTitle=false&size=153474&status=done&style=none&taskId=u705782dd-0491-4ca0-a932-fdff3f17d78&title=&width=1374)
Class Template
![image.png](https://cdn.nlark.com/yuque/0/2023/png/26851474/1674525804600-66f6febb-2814-4e1f-91d6-212ed38a89b8.png#averageHue=%23303338&clientId=u8bb875fa-d76a-4&from=paste&height=788&id=ud6e1571a&originHeight=1576&originWidth=2192&originalType=binary&ratio=1&rotation=0&showTitle=false&size=163805&status=done&style=none&taskId=u5406bfbf-531a-4288-b189-d48b343a9f4&title=&width=1096)
Method Template
![image.png](https://cdn.nlark.com/yuque/0/2023/png/26851474/1674525838023-af8a2af6-31d8-40d0-a8e1-be53af8629da.png#averageHue=%23303334&clientId=u8bb875fa-d76a-4&from=paste&height=790&id=u11932bb8&originHeight=1580&originWidth=2198&originalType=binary&ratio=1&rotation=0&showTitle=false&size=152367&status=done&style=none&taskId=u3443beca-a1ab-4714-96f1-b6574cdeb1b&title=&width=1099)
Field Template
![image.png](https://cdn.nlark.com/yuque/0/2023/png/26851474/1674525861931-39ca3d74-85b6-4bb5-800d-6bf1a1b8d0b3.png#averageHue=%23303334&clientId=u8bb875fa-d76a-4&from=paste&height=787&id=ucd296cec&originHeight=1574&originWidth=2194&originalType=binary&ratio=1&rotation=0&showTitle=false&size=120215&status=done&style=none&taskId=uf96b693e-913c-4ebd-83d3-2d3694fbb2d&title=&width=1097)