如何用Groovydoc声明外部全局变量以支持IntelliJ代码提示？

问题描述 #

我编写的Groovy代码需要在NoMagic/Cameo Enterprise Architecture环境中运行，官方文档说明该环境提供了可直接引用的全局预定义对象（比如示例中的ALH），但IntelliJ IDEA无法识别这些全局变量，导致没有代码补全提示，也无法正确解析方法。

解决方案 #

有两种可靠的方法让IntelliJ识别这些运行时全局变量：

方法1：使用Groovydoc声明全局变量类型 #

在脚本最开头添加Groovydoc注释，通过@def标签明确声明全局变量的类型，IntelliJ会据此识别变量并提供代码补全：

/**
 * @def com.nomagic.magicdraw.simulation.utils.ALH ALH
 */

import com.nomagic.uml2.ext.magicdraw.classes.mdkernel.NamedElement

static void do_stuff(NamedElement e) {
    // Do things...
}

NamedElement my_element = ALH.getCaller() // 现在IDE可识别ALH并提供方法补全
do_stuff(my_element)

方法2：添加IDE专属的占位变量声明 #

在脚本开头添加一个仅用于IDE提示的占位变量（运行时NoMagic会提供真实实例，不会冲突），配合@SuppressWarnings消除未使用提示：

// 仅用于IntelliJ代码提示，运行时由NoMagic提供真实ALH实例
@SuppressWarnings("unused")
private final com.nomagic.magicdraw.simulation.utils.ALH ALH = null

import com.nomagic.uml2.ext.magicdraw.classes.mdkernel.NamedElement

static void do_stuff(NamedElement e) {
    // Do things...
}

NamedElement my_element = ALH.getCaller() // IDE可正常识别变量和方法
do_stuff(my_element)

方法对比 #

• Groovydoc方法更简洁，无多余代码，依赖IntelliJ对Groovydoc@def标签的支持（主流版本均支持）
• 占位变量方法兼容性更强，适用于对Groovydoc支持有限的IDE版本

内容的提问来源于stack exchange，提问作者ABeard89