IDEA文档注释(教程+模板)

最新推荐文章于 2024-08-14 17:45:49 发布

Yongliang Xu (许永亮)

最新推荐文章于 2024-08-14 17:45:49 发布

阅读量1.3k

点赞数 1

本文链接：https://blog.csdn.net/XX_sir/article/details/114601146

版权

JavaSE 专栏收录该内容

7 篇文章 0 订阅

订阅专栏

文件头文档注释

在这里插入图片描述

/**
* @BelongsProject: ${PROJECT_NAME}
* @BelongsPackage: ${PACKAGE_NAME}
* @Auther: ${USER} l1264009784@163.com
* @Date: ${DATE} ${HOUR}:${MINUTE}
* @since JDK 1.8 
* @Description: 
*/

TestDemo:
在这里插入图片描述

类文档注释

在这里插入图片描述

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

TestDemo:
在这里插入图片描述

自定义注释(如方法注释)

在这里插入图片描述

/**
  * @Author $user$
  * @Description 
  * @Date $time$ $date$
  * @Param $param$
  * @Return $return$
  **/

点击Define
在这里插入图片描述
点击Edit variables

点击OK就配置好了，我们来测试
在方法内/**+tab键

第一部分注释为文件文档注释、第二部分是类文档注释、第三部分自定义的方法注释
我的注释例子如下

补充

在这里插入图片描述
Settings右下角的默认键设置，eclipse都是enter，IDEA是默认键是Tab，所以按Tab才能生成自定义注释，当然修改成熟悉的就好。

如图，其实在Java Annotation等选项都可以配置，途中c+Tab键也可以生成定义的类文档注释，多试试，里面有很多功能，熟能生巧