IntelliJ IDEA自动生成自定义的类注释和方法注释

举报
扎哇太枣糕 发表于 2022/09/08 13:33:21 2022/09/08
【摘要】 ​ 目录 自定义的类注释自定义方法注释        实现效果:不用手写即可自动生成如下图的类上注释和方法上的注释,我们只需要填写方法注释的参数和返回值文字描述即可,大大节省了代码开发的时间提高代码开发效率。​编辑🌕 自定义的类注释File-->Settings-->Editor-->File and Code Templates注解内容可自定义,我给出的模板只是我自己的内容/** @C...

 目录

 

自定义的类注释

自定义方法注释


        实现效果:不用手写即可自动生成如下图的类上注释和方法上的注释,我们只需要填写方法注释的参数和返回值文字描述即可,大大节省了代码开发的时间提高代码开发效率。编辑

🌕 自定义的类注释

File-->Settings-->Editor-->File and Code Templates

注解内容可自定义,我给出的模板只是我自己的内容

/**
  @ClassName: 
  @Description: 
  @author: chenhao
  @date: ${DATE}
*/

编辑

🌕 自定义方法注释

File-->Settings-->Editor-->LiveTemplates

第一步:新建一个分组,名称自定义

编辑

第二步:编辑模板

** 
 *$params$ 
 * @author: chenhao
 * @return: 
 */

编辑第三步:编辑变量 

groovyScript(" 	def result='';  	def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList();  	for(i = 0; i < params.size(); i++) { 		if(i == 0 && params[0] == '') result=''; 		else if(i == 0) result += ' \\n' + '     * @param ' + params[i] + ' ' + ((i < params.size() - 1) ? '\\n' : ''); 		else result += '     * @param ' + params[i] + ' ' + ((i < params.size() - 1) ? '\\n' : '') 	};  	return result", methodParameters() ) 

编辑

 第四步:编辑快捷键最后一步编辑

效果展示

编辑

🌕 优化设置 

        通过上述步骤可以实现自定义的类上和方法上注释,但是有一点美中不足的是:设置之后idea会报黄色的warning,虽然不影响运行吧,但是对于有些削微强迫症的我来说,这还是不太能忍受的,那么就想办法祛除这种warning吧编辑

 Settings  => Editor => Inspections => 复制并搜索Declaration has Javadoc Problems. => options => add java doc tags编辑

 修改配置后的代码就没有了报黄,看起来就很是赏心悦目编辑


【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。