idea常用插件及代码注释

我就是我 2023-02-23 08:45 0阅读 0赞

# 一、常用插件 #

<table> 
 <tbody> 
 <tr> 
 <td> 插件名称 </td> 
 <td> 插件介绍 </td> 
 <td> 官网地址 </td> 
 </tr> 
 <tr> 
 <td> Alibaba Java Coding Guidelines </td> 
 <td> 阿里巴巴代码规范检查插件 </td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines" rel="nofollow">https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines</a> </td> 
 </tr> 
 <tr> 
 <td> Key promoter </td> 
 <td> 快捷键提示插件 </td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/4455?pr=idea" rel="nofollow">https://plugins.jetbrains.com/plugin/4455?pr=idea</a> </td> 
 </tr> 
 <tr> 
 <td> Grep Console </td> 
 <td> 自定义控制台输出格式插件 </td> 
 <td> <a href="https://plugins.jetbrains.com/idea/plugin/7125-grep-console" rel="nofollow">https://plugins.jetbrains.com/idea/plugin/7125-grep-console</a> </td> 
 </tr> 
 <tr> 
 <td> CheckStyle-IDEA </td> 
 <td> 代码规范检查插件 </td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/1065?pr=idea" rel="nofollow">https://plugins.jetbrains.com/plugin/1065?pr=idea</a> </td> 
 </tr> 
 <tr> 
 <td> FindBugs-IDEA </td> 
 <td> 潜在 Bug 检查 </td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/3847?pr=idea" rel="nofollow">https://plugins.jetbrains.com/plugin/3847?pr=idea</a> </td> 
 </tr> 
 <tr> 
 <td> MetricsReloaded </td> 
 <td> 代码复杂度检查 </td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/93?pr=idea" rel="nofollow">https://plugins.jetbrains.com/plugin/93?pr=idea</a> </td> 
 </tr> 
 <tr> 
 <td> Statistic </td> 
 <td> 代码统计插件 </td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/4509?pr=idea" rel="nofollow">https://plugins.jetbrains.com/plugin/4509?pr=idea</a> </td> 
 </tr> 
 <tr> 
 <td> JRebel Plugin </td> 
 <td> 热部署插件 </td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/?id=4441" rel="nofollow">https://plugins.jetbrains.com/plugin/?id=4441</a> </td> 
 </tr> 
 <tr> 
 <td> CodeGlance </td> 
 <td> 显示代码地图插件 </td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/7275?pr=idea" rel="nofollow">https://plugins.jetbrains.com/plugin/7275?pr=idea</a> </td> 
 </tr> 
 <tr> 
 <td> Markdown Navigator </td> 
 <td> Markdown 编辑器插件 </td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/7896?pr=idea" rel="nofollow">https://plugins.jetbrains.com/plugin/7896?pr=idea</a> </td> 
 </tr> 
 <tr> 
 <td> Jindent-Source Code Formatter </td> 
 <td> 自定义模板插件 </td> 
 <td> <a href="http://plugins.jetbrains.com/plugin/2170?pr=idea" rel="nofollow">http://plugins.jetbrains.com/plugin/2170?pr=idea</a> </td> 
 </tr> 
 <tr> 
 <td> Maven Helper </td> 
 <td> Maven 辅助插件 </td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/7179-maven-helper" rel="nofollow">https://plugins.jetbrains.com/plugin/7179-maven-helper</a> </td> 
 </tr> 
 <tr> 
 <td> Properties to YAML Converter </td> 
 <td> Properties 转 YAML 格式插件 </td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/8000-properties-to-yaml-converter" rel="nofollow">https://plugins.jetbrains.com/plugin/8000-properties-to-yaml-converter</a> </td> 
 </tr> 
 <tr> 
 <td> Git Flow Integration </td> 
 <td> Git Flow 集成插件 </td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/7315-git-flow-integration" rel="nofollow">https://plugins.jetbrains.com/plugin/7315-git-flow-integration</a> </td> 
 </tr> 
 <tr> 
 <td>Stackoverflow&nbsp;</td> 
 <td>使用它查找问题使用的是google搜索引擎</td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/9513-stackoverflow" rel="nofollow">https://plugins.jetbrains.com/plugin/9513-stackoverflow</a> </td> 
 </tr> 
 <tr> 
 <td>TranslationPlugin</td> 
 <td>翻译</td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/10121-googletranslation" rel="nofollow">https://plugins.jetbrains.com/plugin/10121-googletranslation</a> </td> 
 </tr> 
 <tr> 
 <td>JUnitGenerator V2.0</td> 
 <td>单元测试</td> 
 <td> <a href="https://plugins.jetbrains.com/plugin/3064-junitgenerator-v2-0" rel="nofollow">https://plugins.jetbrains.com/plugin/3064-junitgenerator-v2-0</a> </td> 
 </tr> 
 </tbody> 
</table>

# 二、代码注释 #

## 2.1 类注释 ##

打开`Preferences-->Editor-->File and Code Templates`，右侧选择`Files`tab页，找到`Class`、`Interface`，可以看到右侧模板里引用了一个`File Header.java`模板

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjU3OTA5_size_16_color_FFFFFF_t_70][]

/** 
     * TODO
     * @version 1.0
     * @author ${USER} 
     * @date ${DATE} ${TIME} 
     */

## 2.2 方法注释 ##

打开`Preferences-->Editor-->Live Templates`，为了方便管理，新建一个分组来管理自己添加的Template Group

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjU3OTA5_size_16_color_FFFFFF_t_70 1][]

2.再在该组下新建`Live Templates`

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjU3OTA5_size_16_color_FFFFFF_t_70 2][]

`便捷内容如下`

*
     * 
     * $params$ 
     * @author $user$ 
     * @date $date$ $time$ 
     * @return $return$
     */

3.调节参数

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjU3OTA5_size_16_color_FFFFFF_t_70 3][]

params 中内容如下

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] == '') return result;if(i==0) result += '\\n'; result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjU3OTA5_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200706185516115.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjU3OTA5,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjU3OTA5_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200706185718694.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjU3OTA5,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjU3OTA5_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200706185842908.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjU3OTA5,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjU3OTA5_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200706185959508.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5NjU3OTA5,size_16,color_FFFFFF,t_70