NCQL 集成开发环境教程

本文阅读时长:8分钟更新于2025-06-10

一、功能介绍

NCQL是一款用于分析模型数据,分析模型是否满足某种特征的查询语言,下文为描述“NCQL”的集成开发环境教程

二、面向用户

全体参数化编辑器建模的用户

三、操作步骤

1、入口

第一步:通过 模型检测功能入口 ,点击 “管理自定义特征”打开“ NCQL IDE”

第二步:点击弹窗中的“NCQL教程”,可以打开本页面

2、页面布局

1)IDE分为四个主要部分。分别是:

  • 左侧的特征管理区:你可以查看系统特征,可以创建、修改自己的用户特征
  • 中间上方的脚本编辑区:在左侧特征管理区选中特征后,你可以在这个面板中修改这个特征的 NCQL 脚本,可以保存或另存为
  • 右侧上方的错误信息区:当你编写的 NCQL 存在语法错误或漏洞时,这个面板会展示你脚本中的问题
  • 下方的文档区:你可以在这里找到NCQL支持所有数据类型所有函数

2)IDE 的布局是可调节的,鼠标放到不同区块的交界时,你可以拖动边缘来调整各个部分的大小

3、特征管理区

1)特征分为系统特征和用户特征。其中,系统特征是不可编辑、不可删除的,对于系统脚本,你可以点开查看它的实现,或另存为一份到自己的用户特征里进行修改

2)对于用户特征,你可以随意添加、修改、删除

4、特征管理顶部栏

1)在特征管理顶部栏(下图中绿框的部分)中,你可以修改特征的名称(鼠标点击 ✅ 来保存名称,点击❎ 放弃修改名称)

2)修改脚本后,名称右边会出现橙色字样 “未保存的变更”,这代表着你修改了脚本但并没有保存它。此时可以点击右侧的“保存”按钮来保存当前的脚本,也可以点击“另存为”来创建一个新的

5、错误检测

1)你编写的脚本必须完全遵守NCQL的语法和数据结构的定义。如果你编写的脚本中存在语法错误或风险,IDE 会将有问题的地方标记下划线鼠标放在下划线上,将会弹出气泡,告诉你错误在哪里

2)红色下划线代表严重错误,存在严重错误的时候,你将无法保存此脚本。橙色下划线代表警告,此时你可以保存脚本,但确实存在风险

3)错误信息同时也会出现在右侧的错误信息面板

6、类型提示

第一步:在编写脚本的过程中,你会发现各种各样的“小灰框”,如下图所示:

第二步:这些小灰框是“类型提示”,它告诉你某个变量是什么类型。以图中的几个类型提示为例,它说明了:

  • model 变量的类型是 FModelDefinition (模型)
  • W 变量的类型是 float (浮点数)
  • D 变量的类型是 float (浮点数)
  • H 变量的类型是 float (浮点数)
  • falseString 变量的类型是 String (字符串)
  • s 变量的类型是 FModelInstance (子模型)

第三步:当鼠标放在类型提示上时,光标所在位置会显示气泡“查看类型文档”。此时键盘按下Ctrl(如果是 mac 系统则是 cmd)后,鼠标单击这个类型提示,页面下方的文档区域会自动打开此类型的文档

7、自动补全

当你在IDE中编写脚本时,IDE会猜测你想要输入什么内容,并以列表的形式展示出来。比如当你输入 # 时,系统会给你展示推荐列表,此时可以使用键盘上下键来挑选想要的推荐,使用enter键来接受推荐。如果推荐结果不是你想要的,直接忽略它,继续输入即可

8、字段、函数文档

鼠标放在字段、函数或变量上时,IDE 会弹出气泡,告诉你这个字段、函数或变量是什么,此时你可以使用 Ctrl(mac系统为cmd)+鼠标左键点击,来打开对应字段(或函数)的文档

9、文档区

1)文档区展示了你所有可用的数据类型和函数。它们按照逻辑关系来分组,你可以展开或收起它们

2)类型文档中会包含类型的含义、字段的类型及解释,以及类型支持调用的方法

3)函数文档中会包含函数的用途、参数列表以及返回值

 

 

可以随时点赞啦