Idea 快捷生成类注释与方法注释

  这篇博客应该在刚使用IDEA 的时候就写了.  但是一直忘了.  今天使用新的api 接口文档生成工具 JApiDocs  的时候,看其上面有编码规范, 注释规范. 就想起了IDEA 类中, 方法中快捷生成注释. 回想了下, 写篇博客来记录记录.  

一. 效果图

二. 快捷生成类注释

 File ---> Settings...(或者快捷键Ctrl+Alt+S) 进入设置页面 

 

 

 模板

/**
*@ClassName: ${NAME}
*@Description: ${description}
*@Author 
*@Date ${DATE}
*@Version 1.0
*
*/

  1. ${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名

  2. TODO:代办事项的标记,一般生成类或方法都需要添加描述

  3. ${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}

  4. 1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了

  其余的可以自行去百度

三. 快捷生成方法注释

 File ---> Settings...(或者快捷键Ctrl+Alt+S) 进入设置页面 

 

 

 模板

*
 * @Author xxx
 * @Description 
 * @Date  $date$
 * @Param $param$ 
 * @Return $return$
 * @MethodName $methodName$
 *

  注意是*开头,不是/**开头.  方法注释模板中的参数是 $ $, 而类中的是${ }. 

  LiveTemplate 还是很好用的, 很多通用常用的代码模块可以设置为模板, 以后使用的时候直接快捷键输入即可 

posted @ 2020-06-22 12:36  经济人  阅读(13738)  评论(3编辑  收藏  举报