idea类和方法的注释

司南杓

已于 2023-06-04 16:33:18 修改

阅读量151

点赞数

文章标签： intellij-idea java spring

于 2023-06-04 16:29:53 首次发布

本文链接：https://blog.csdn.net/h1429541165/article/details/131033792

版权

idea类和方法的注释

类的注释

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-jHOJSFiB-1685867187575)(idea%E7%B1%BB%E5%92%8C%E6%96%B9%E6%B3%95%E7%9A%84%E6%B3%A8%E9%87%8A.assets/image-20230604161244828.png)]

在第5部分写入以下代码

/**
 * @Author: sinan
 * @CreateTime: ${YEAR}-${MONTH}-${DAY} ${TIME}
 * @Description:
 */

创建一个People类，类的上面就会有注释了

package com.sinan.common.entity;

/**
 * @Author: sinan
 * @CreateTime: 2023-06-04 16:13
 * @Description:
 */
public class People {
}

方法的注释

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-T9aYNcws-1685867187576)(idea%E7%B1%BB%E5%92%8C%E6%96%B9%E6%B3%95%E7%9A%84%E6%B3%A8%E9%87%8A.assets/image-20230604161616224.png)]

第4步输入名称，MethodTemplate

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-9KHynnLm-1685867187577)(idea%E7%B1%BB%E5%92%8C%E6%96%B9%E6%B3%95%E7%9A%84%E6%B3%A8%E9%87%8A.assets/image-20230604161816736.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-famsUSCW-1685867187578)(idea%E7%B1%BB%E5%92%8C%E6%96%B9%E6%B3%95%E7%9A%84%E6%B3%A8%E9%87%8A.assets/image-20230604161944615.png)]

依次填入上述内容，代码块如下：

**
 $param$
 $return$
 * @description 
 */

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-TjYFBq1B-1685867187578)(idea%E7%B1%BB%E5%92%8C%E6%96%B9%E6%B3%95%E7%9A%84%E6%B3%A8%E9%87%8A.assets/image-20230604162127350.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-0qLzrKXZ-1685867187579)(idea%E7%B1%BB%E5%92%8C%E6%96%B9%E6%B3%95%E7%9A%84%E6%B3%A8%E9%87%8A.assets/image-20230604162149658.png)]

写入内容，勾选对勾，内容如下

param:
groovyScript("def result = '';def params = \"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {if(params[i] != '')result+='* @param ' + params[i] + ((i < params.size() - 1) ? '\\r\\n ' : '')}; return result == '' ? '* @param' : result", methodParameters()) 
return:
groovyScript("def params=\"${_1}\";def index=params.lastIndexOf('.', params.indexOf('<'));if(index!=-1){params=params.substring(index+1);};index1=params.lastIndexOf('<', params.indexOf('.'));  index2=params.indexOf('.');while(index1!=-1&&index2!=-1){replaceTemp=params.substring(index1+1,index2+1);  	if(replaceTemp.indexOf(',')==-1){params=params.replaceAll(replaceTemp, '');index1=params.lastIndexOf('<', params.indexOf('.')); 		index2=params.indexOf('.');}else{index1=params.lastIndexOf(',', params.indexOf('.'));index2=params.indexOf('.');} 	  };if(params.indexOf(',')==-1){params=params.substring(params.lastIndexOf('.')+1);};return '* @return ' + params", methodReturnType())

写一个方法，在方法上面输入/**，然后敲回车就可以了，效果图如下：

public class People {
    /**
     * @param age
     * @param name
     * @return String
     * @description 
     */
    String hello(int age, String name){
        return "hello world";
    }
}