IDEA 利用groovy脚本生成注释

简介: 【10月更文挑战第29天】在 IntelliJ IDEA 中,可以通过创建和运行 Groovy 脚本来自动生成 Java 类方法的 Javadoc 注释。首先,创建一个 Groovy 文件并编写脚本,该脚本会检查每个方法是否已有注释,如果没有,则生成包含方法描述、参数列表和返回值的基本注释。接着,通过“Tools”菜单下的“Groovy Console”运行脚本,确保脚本中的包版本与当前使用的 IntelliJ IDEA 版本匹配。运行后,脚本将自动为选定类的方法添加注释。建议在执行前备份代码,以防意外。

在 IntelliJ IDEA 中,可以使用 Groovy 脚本为代码生成注释。以下是具体的步骤和示例:


一、创建 Groovy 脚本


  1. 在 IntelliJ IDEA 中,打开一个项目或者创建一个新的项目。
  2. 在项目结构中,找到一个合适的位置来创建一个新的 Groovy 文件。可以右键点击项目名称,选择 “New” -> “Groovy File”,并为文件命名,比如 “GenerateComments.groovy”。


二、编写 Groovy 脚本


以下是一个简单的 Groovy 脚本示例,用于为 Java 类中的方法生成基本的 Javadoc 注释:


import com.intellij.openapi.project.Project
import com.intellij.psi.PsiClass
import com.intellij.psi.PsiElementFactory
import com.intellij.psi.PsiMethod
import com.intellij.psi.JavadocTokenType
import com.intellij.psi.codeStyle.JavaCodeStyleManager
def project = getProject()
def elementFactory = PsiElementFactory.getInstance(project)
def psiClass = getSelectedPsiClass()
psiClass.methods.each { method ->
    if (!method.docComment) {
        def commentText = "/**\n" +
                " * ${method.name} method description.\n" +
                " *\n" +
                " * @param ${method.parameters.join(', ')}\n" +
                " * @return ${method.returnType.canonicalText}\n" +
                " */"
        def docComment = elementFactory.createDocCommentFromText(commentText)
        method.setDocComment(docComment)
        JavaCodeStyleManager.getInstance(project).shortenClassReferences(method)
    }
}
PsiClass getSelectedPsiClass() {
    def editor = project.getComponent(com.intellij.openapi.editor.EditorFactory).getSelectedTextEditor()
    if (editor) {
        def psiFile = editor.document.psiFile
        def element = psiFile.findElementAt(editor.caretModel.offset)
        while (element!= null &&!(element instanceof PsiClass)) {
            element = element.getParent()
        }
        return element as PsiClass
    }
    return null
}


这个脚本遍历当前选中的 Java 类中的所有方法,如果方法没有注释,则为其生成一个基本的 Javadoc 注释。注释包括方法描述、参数列表和返回值。


三、运行 Groovy 脚本


  1. 在 IntelliJ IDEA 中,打开你想要为其生成注释的 Java 类文件。
  2. 选择 “Tools” -> “Groovy Console” 打开 Groovy 控制台。
  3. 在 Groovy 控制台中,输入以下命令来加载并运行你的脚本:


@Grab('com.intellij:idea_rt:2024.2.3')
import GenerateComments
new GenerateComments()


确保将脚本中的包版本号更新为你使用的 IntelliJ IDEA 版本对应的包版本号。


  1. 运行脚本后,脚本将为当前选中的 Java 类中的方法生成注释。


请注意,这个示例只是一个简单的演示,你可以根据自己的需求修改脚本以生成更复杂的注释。同时,使用脚本生成注释应该谨慎,确保生成的注释准确反映代码的功能。此外,在运行脚本之前,最好备份你的代码,以防出现意外情况。

相关文章
|
1月前
|
SQL 存储 关系型数据库
MySQL 与 IntelliJ IDEA 同时兼容的注释
MySQL 与 IntelliJ IDEA 同时兼容的注释
28 2
|
1月前
|
Java
IDEA自定义配置注释模板,让你看起来更加专业!!!
IDEA自定义配置注释模板,让你看起来更加专业!!!
|
3月前
|
XML 数据格式
IDEA 行注释设置,使其不从顶格开始,让其处于代码前开始
这篇文章提供了IntelliJ IDEA中如何设置行注释不从顶格开始,而是紧接在代码前面的方法,通过访问Settings中的Code Style选项进行调整,以改善代码注释的视觉效果。
IDEA如何设置取消 请不要使用行尾注释 提示
文章介绍了如何在 IntelliJ IDEA 中设置以取消行尾注释的提示。这个问题通常由使用阿里规范插件导致,插件会在不满足规范时在代码中显示黄色波浪线提示。为了改善代码编辑体验,文章提供了详细的步骤说明,指导用户通过进入 "File" -> "Settings" -> "Editor" -> "Inspections" 来取消特定检查项,从而消除这些提示。修改设置后,代码界面将不再显示黄色波浪线,看起来更加清爽。
IDEA如何设置取消 请不要使用行尾注释 提示
|
3月前
IDEA——代码文件如何插入作者注释
IDEA——代码文件如何插入作者注释
43 0
|
3月前
Intellij idea 生成带注释的get/set
Intellij idea 生成带注释的get/set
105 0
|
5月前
idea 自动加头部注释
idea 自动加头部注释
31 2
|
6月前
|
XML Java 数据格式
idea注释顶格不美观的问题--代码与XML
idea注释顶格不美观的问题--代码与XML
49 6
|
6月前
Mac上IntelliJ IDEA设置类注释和方法注释带作者和日期
Mac上IntelliJ IDEA设置类注释和方法注释带作者和日期
389 0
|
6月前
idea生成方法注释的正确方法
idea生成方法注释的正确方法
101 0