草庐IT

IDEA生成带参数和返回值注释

Wenjie 2023-04-17 原文


步骤说明


打开IDEA进入点击左上角 - 文件 - 设置 - 编辑器 - 活动模板

新建活动模板

填写模板文本

编辑变量

添加变量表达式

设置模板使用范围-设置全部范围应用-或者设置只在Java代码中使用等（看到最后）


打开IDEA进入 - 设置 - 编辑器 - 活动模板


  1. 选择Live Template 新建一个模板---或者选择下面一个Template Group 新建一个模板组在这个模板组下面再次点击Live Template 新建模板、填写模板文本----模板文本如下（可自行增删改）：

    
**
 * $param$
 * @return $return$
 * @date $date$ $time$
 * @description $description$
 */

  1. 看图填空---缩写可自行定义这就是你调出这个注释的快捷键 , 我就按一般形式写的 ** , 这里我设置了参数、返回值、时间、描述四个值,模板文本上图已提供


  1. 点击上图中的编辑变量


  1. 其他的值对应的表达式照着填即可 , 以下是 return 、 param 的表达式（注意：上图中return表达式返回的是全类名导致返回值过长--不建议使用、下面已提供return的表达式）
  • return表达式：
    
groovyScript("
	def result='';  
	def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); 
	for(i = 0; i < params.size(); i++) {
		if(i!=0){
			result+='<';
		};  
		def p1=params[i].split(',').toList(); 
		for(i2 = 0; i2 < p1.size(); i2++)  { 
			def p2=p1[i2].split('\\\\.').toList();  
			result+=p2[p2.size()-1];
			if(i2!=p1.size()-1){
				result+=','
			}  
		} ; 
	};  
	return result", methodReturnType())

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

  • 显示效果：

    
/**
 * @param （参数1）
 * @param （参数2）
 * (......)
 * @return 返回值
 * @data 时间
 * @description 描述
 */

现象一：IDEA提示悬空的注解


注释检查，可以通过以下方式禁用它：

  1. 点击idea左上角文件->点击设置

  2. 导航到编辑器 --> 检查

  3. 在右侧菜单列表下，选择 Java --> JavaDoc---也可直接搜索 JavaDoc

  4. 取消选中“悬空 Javadoc 注释”


现象二：IDEA提示标签说明已丢失


注释检查，可以通过以下方式禁用它：

  1. 点击idea左上角文件->点击设置

  2. 导航到编辑器 --> 检查

  3. 在右侧菜单列表下，选择 Java --> JavaDoc---也可直接搜索 JavaDoc

  4. 取消选中“声明有 Javadoc 的问题”


使用范围设置


记得选择注释使用范围---一般直接选择全部或者选择Java即可 , 方便又省事。也可以根据需求自行选择使用范围



最后点击 应用 、确认 就可以了。


注释使用


来到需要注释的 方法上 输入 /** 点击回车即可调出刚刚设置的注释


以上是根据我自己的喜好来设置的看着也还行、对于那些怕麻烦的朋友们就直接按着步骤来即可无需过多的设置
如果想要其他注释效果的在这基础上稍加修改即可。表达式也比较简单 , 看一下修改的地方也就是if判断和返回值了


以上方法本人亲测有效、没达到效果的伙伴们可以评论区留言解答

IDEA生成codelibrJava

有关IDEA生成带参数和返回值注释的更多相关文章

  1. ruby - 使用 RubyZip 生成 ZIP 文件时设置压缩级别 - 2

    我有一个Ruby程序，它使用rubyzip压缩XML文件的目录树。gem。我的问题是文件开始变得很重，我想提高压缩级别，因为压缩时间不是问题。我在rubyzipdocumentation中找不到一种为创建的ZIP文件指定压缩级别的方法。有人知道如何更改此设置吗？是否有另一个允许指定压缩级别的Ruby库？ 最佳答案 这是我通过查看ruby​​zip内部创建的代码。level=Zlib::BEST_COMPRESSIONZip::ZipOutputStream.open(zip_file)do|zip|Dir.glob("**/*")d

  2. ruby - 为什么 4.1%2 使用 Ruby 返回 0.0999999999999996？但是 4.2%2==0.2 - 2

    为什么4.1%2返回0.0999999999999996？但是4.2%2==0.2。 最佳答案 参见此处:WhatEveryProgrammerShouldKnowAboutFloating-PointArithmetic实数是无限的。计算机使用的位数有限(今天是32位、64位)。因此计算机进行的浮点运算不能代表所有的实数。0.1是这些数字之一。请注意，这不是与Ruby相关的问题，而是与所有编程语言相关的问题，因为它来自计算机表示实数的方式。 关于ruby-为什么4.1%2使用Ruby返

  3. ruby - 在 jRuby 中使用 'fork' 生成进程的替代方案？ - 2

    在MRIRuby中我可以这样做:deftransferinternal_server=self.init_serverpid=forkdointernal_server.runend#Maketheserverprocessrunindependently.Process.detach(pid)internal_client=self.init_client#Dootherstuffwithconnectingtointernal_server...internal_client.post('somedata')ensure#KillserverProcess.kill('KILL',

  4. ruby - 如何使用 Ruby aws/s3 Gem 生成安全 URL 以从 s3 下载文件 - 2

    我正在编写一个小脚本来定位aws存储桶中的特定文件，并创建一个临时验证的url以发送给同事。(理想情况下，这将创建类似于在控制台上右键单击存储桶中的文件并复制链接地址的结果)。我研究过回形针，它似乎不符合这个标准，但我可能只是不知道它的全部功能。我尝试了以下方法:defauthenticated_url(file_name,bucket)AWS::S3::S3Object.url_for(file_name,bucket,:secure=>true,:expires=>20*60)end产生这种类型的结果:...-1.amazonaws.com/file_path/file.zip.A

  5. ruby - 检查字符串是否包含散列中的任何键并返回它包含的键的值 - 2

    我有一个包含多个键的散列和一个字符串，该字符串不包含散列中的任何键或包含一个键。h={"k1"=>"v1","k2"=>"v2","k3"=>"v3"}s="thisisanexamplestringthatmightoccurwithakeysomewhereinthestringk1(withspecialcharacterslike(^&*$#@!^&&*))"检查s是否包含h中的任何键的最佳方法是什么，如果包含，则返回它包含的键的值？例如，对于上面的h和s的例子，输出应该是v1。编辑:只有字符串是用户定义的。哈希将始终相同。 最佳答案

  6. ruby-on-rails - Ruby on Rails - 为文本区域和图片生成列 - 2

    我是Rails的新手，所以请原谅简单的问题。我正在为一家公司创建一个网站。那家公司想在网站上展示它的客户。我想让客户自己管理这个。我正在为“客户”生成一个表格，我想要的三列是:公司名称、公司描述和Logo。对于名称，我使用的是name:string但不确定如何在脚本/生成脚手架终端命令中最好地创建描述列(因为我打算将其设置为文本区域)和图片。我怀疑描述(我想成为一个文本区域)应该仍然是描述:字符串，然后以实际形式进行调整。不确定如何处理图片字段。那么……说来话长:我在脚手架命令中输入什么来生成描述和图片列？ 最佳答案 对于“文本”数

  7. ruby - Ruby 中的隐式返回值是怎么回事？ - 2

    所以我开始关注ruby​​，很多东西看起来不错，但我对隐式return语句很反感。我理解默认情况下让所有内容返回self或nil但不是语句的最后一个值。对我来说，它看起来非常脆弱(尤其是)如果你正在使用一个不打算返回某些东西的方法(尤其是一个改变状态/破坏性方法的函数!)，其他人可能最终依赖于一个返回对方法的目的并不重要，并且有很大的改变机会。隐式返回有什么意义？有没有办法让事情变得更简单？总是有返回以防止隐含返回被认为是好的做法吗？我是不是太担心这个了？附言当人们想要从方法中返回特定的东西时，他们是否经常使用隐式返回，这不是让你组中的其他人更容易破坏彼此的代码吗？当然，记录一切并给出

  8. ruby-on-rails - 如何生成传递一些自定义参数的 `link_to` URL？ - 2

    我正在使用RubyonRails3.0.9，我想生成一个传递一些自定义参数的link_toURL。也就是说，有一个articles_path(www.my_web_site_name.com/articles)我想生成如下内容:link_to'Samplelinktitle',...#HereIshouldimplementthecode#=>'http://www.my_web_site_name.com/articles?param1=value1¶m2=value2&...我如何编写link_to语句“alàRubyonRailsWay”以实现该目的？如果我想通过传递一些

  9. ruby-on-rails - 如何在 Rails 3 中创建自定义脚手架生成器？ - 2

    有这些railscast。http://railscasts.com/episodes/218-making-generators-in-rails-3有了这个，你就会知道如何创建样式表和脚手架生成器。http://railscasts.com/episodes/216-generators-in-rails-3通过这个，您可以了解如何添加一些文件来修改脚手架View。我想把两者结合起来。我想创建一个生成器，它也可以创建脚手架View。有点像RyanBates漂亮的生成器或web_app_themegem(https://github.com/pilu/web-app-theme)。我

  10. ruby-on-rails - ruby 日期方程不返回预期的真值 - 2

    为什么以下不同？Time.now.end_of_day==Time.now.end_of_day-0.days#falseTime.now.end_of_day.to_s==Time.now.end_of_day-0.days.to_s#true 最佳答案 因为纳秒数不同:ruby-1.9.2-p180:014>(Time.now.end_of_day-0.days).nsec=>999999000ruby-1.9.2-p180:015>Time.now.end_of_day.nsec=>999999998

随机推荐