zl程序教程

您现在的位置是:首页 >  后端

当前栏目

Java-idea-设置类头注释和方法注释

JAVAIDEA方法 设置 注释
2023-09-14 09:08:49 时间

 一、文件级别的注释

        主要是通过File--》Setting--》Editor→File and Code Template中来设置
    可以再右侧include中设置File Header
  可设置值:

Predefined variables will take the following values:
${PACKAGE_NAME}name of the package in which the new file is created
${USER}current user system login name
${DATE}current system date
${TIME}current system time
${YEAR}current year
${MONTH}current month
${MONTH_NAME_SHORT}first 3 letters of the current month name. Example: Jan, Feb, etc.
${MONTH_NAME_FULL}full name of the current month. Example: January, February, etc.
${DAY}current day of the month
${DAY_NAME_SHORT}first 3 letters of the current day name. Example: Mon, Tue, etc.
${DAY_NAME_FULL}full name of the current day. Example: Monday, Tuesday, etc.
${HOUR}current hour
${MINUTE}current minute
${PROJECT_NAME}the name of the current project

个人一般设置成

/**
 * @className ${NAME} 
 * @description TODO
 * @author ${USER}
 * @since ${DATE} ${TIME}
 * @version 1.0
 */ 

二、方法级别的注释

基于Live Template
  基础的Live Template
  psvm+tab,main方法
  iter+tab,foreach语句
  live template还有一个surround的用法,选中某个变量,键入ctl+alt+j两次,则会出现自动补全的菜单
基本步骤
  1、点击File--》Setting--》Editor→Live Template,点击右侧的+号,选择Template Group
  2、输入MyGroup(你也可以输入其他自定义的名称),然后点击OK。
  3、选中MyGroup之后,再次点击右侧的+号,选择Live Template,

 

   其中Abbreviation 必须是* ,使用过程中可以输入 /**  回车即可

   模板

*
 * @description TODO
 * @author $user$
 * @since $date$ $time$
$param$
 * @return $return$
 */
  4、点击第四步的Define,选择EveryWhere 选择java即可
  5、点击右边的Edit variables
其中 $param$ 的表达式值
groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result", methodParameters())
  其他的按照实际下拉选择即可
  6、点击OK,方法上输入 /**  回车即可