IntelliJ IDEA2022中的Java文档注释设置、操作详述

迈不过友情╰ 2023-09-28 19:11 6阅读 0赞

1、打开IDEA，点击setting-Editor-Live Templates。

![在这里插入图片描述][505779d8ff2f4a1dbb36e091d3d6c76d.png]

2、点击右方的“+”准备进行文档注释的内容和快捷键设置。

![在这里插入图片描述][f604d557fc934cd4a1a6a5de86119072.png]

右键，选中 change context，勾选中Java。

![在这里插入图片描述][22372c6c244344c3890ec9c4c5e7a6c6.png]  
![在这里插入图片描述][c651c3598cd440afbe6a764a50692ded.png]

3、自定义文档注释模板，在Abbreviation中输入模块名称，在Description中输入描述，在Template text中输入注释内容。

![在这里插入图片描述][e825cee5dd724f63af6850dda8200319.png]  
自定义的注释内容依次是描述、作者、日期、参数。

/**
     *@description：  
     *@author：$USER$
     *@date：$DATE$ $TIME$
     *@param：$param$
     */

4、在Options下的Expand with中设置触发快捷键。

![在这里插入图片描述][6e7a601704ad46d1add19f0a515cab0f.png]

5、点击Eidt variables，进行注释内容配置，配置如图所示，完成后点即OK和Apply即可。

![在这里插入图片描述][10212934a3e842f385b4135f172ec434.png]

6、IDEA的文档注释效果展示，输入/\*\*，按下Enter即可展示之前配置好的文档注释。

![在这里插入图片描述][1e58c7af3bf64591a14747c9f5aba812.png]

[505779d8ff2f4a1dbb36e091d3d6c76d.png]: https://img-blog.csdnimg.cn/505779d8ff2f4a1dbb36e091d3d6c76d.png
[f604d557fc934cd4a1a6a5de86119072.png]: https://img-blog.csdnimg.cn/f604d557fc934cd4a1a6a5de86119072.png
[22372c6c244344c3890ec9c4c5e7a6c6.png]: https://img-blog.csdnimg.cn/22372c6c244344c3890ec9c4c5e7a6c6.png
[c651c3598cd440afbe6a764a50692ded.png]: https://img-blog.csdnimg.cn/c651c3598cd440afbe6a764a50692ded.png
[e825cee5dd724f63af6850dda8200319.png]: https://img-blog.csdnimg.cn/e825cee5dd724f63af6850dda8200319.png
[6e7a601704ad46d1add19f0a515cab0f.png]: https://img-blog.csdnimg.cn/6e7a601704ad46d1add19f0a515cab0f.png
[10212934a3e842f385b4135f172ec434.png]: https://img-blog.csdnimg.cn/10212934a3e842f385b4135f172ec434.png
[1e58c7af3bf64591a14747c9f5aba812.png]: https://img-blog.csdnimg.cn/1e58c7af3bf64591a14747c9f5aba812.png