IDEA中如何自定义类的注释和方法的注释

r囧r小猫 2022-11-28 10:37 182阅读 0赞

## 设计类的注释 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 1]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 2]

> 打开 File > Settings > Editor > File and Code Templates,点击class

> 在类的头部添加如下代码

/**
    *@ClassName ${NAME}
    *@Description  TODO
    *@Author ${USER}
    *@Date ${DATE} ${TIME}
    *@Version 1.0
    */

> 最后点击应用（Apply）

## 设计方法的注释 ##

> 打开File > Settings > Editor > Live Templates,点击添加号  
> ![在这里插入图片描述][20200817105633729.png_pic_center]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 4]

> 给自己定义一个组，在弹出的框中输入自己的组名称  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 5]

> 找到自己的组，再次点击右上角+号，添加Live Template。  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 6]

更改一下：这里设置的启动方式是 /\*wan+回车enter

> 首先添加注释的快捷输入，必须以星号开头，然后添加注释的描述（可以不写），接着修改注释的快捷键（本人建议Enter），最后写入注释的内容

> 注意：单个星号开头

* 
    *@author $USER$
    *@Description $Description$
    *@Date $time$ $date$
    *@Param $param$
    *@Return $return$
    **/

> 添加注释的变量函数

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 7]

> 点击最下面的警告  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 8]  
> 根据需要自己选择需要注释的语言

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 9]

**如果修改过，则点击change，everyWhere > java,一般都在java中使用，可以根据自己的使用情况自己设计。**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 10]

> 再次更改以后

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 11]  
到此，IDEA中如何自定义类的注释和方法的注释就算完成了！感谢。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 12]

教程视频会同步在后面。  
[https://www.bilibili.com/video/BV1HT4y1L7t1][https_www.bilibili.com_video_BV1HT4y1L7t1]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center]: /images/20221124/de45616aa2ae4b33a741f35a8f70d455.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221124/b3cb57591fb5480c960f1d22c422263f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221124/e46ba96d56d54d528c09ed4358c80568.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221124/9eca0ac7cc8d4334a66f301c062966e4.png
[2020081710550615.png_pic_center]: /images/20221124/58c30c67d7cf47818c72d336cf376d5d.png
[20200817105633729.png_pic_center]: /images/20221124/98b3b920a9144dc5ac98bb1f9e18623e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221124/4c0c890279fb468da8fabc7e01b13a3b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221124/a791611797294df8b38d2b6dd2874133.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221124/62c58a375e6545c9933f56974b62d707.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 7]: /images/20221124/5c91625ef76148b9a475aec24974ee1e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 8]: /images/20221124/aeaf5ad621274548802b5b19bd582bd8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 9]: /images/20221124/2607bb5d7e2a47dbb2367e593e0fe456.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 10]: /images/20221124/36862fceee8b4d8990c06f592c4b4fa8.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 11]: /images/20221124/7ee84033e0384363a22125a2654afefd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NjA0NzI4NQ_size_16_color_FFFFFF_t_70_pic_center 12]: /images/20221124/a7d319f091b94c7288926a9f6acb1225.png
[https_www.bilibili.com_video_BV1HT4y1L7t1]: https://www.bilibili.com/video/BV1HT4y1L7t1