代码补全功能中内置函数与变量的存储选型及版本化方案咨询

存储方式选择 #

1. 优先用独立结构化配置文件 #

推荐把内置函数、变量信息存在JSON/YAML这类易读易解析的独立文件中，比如命名为builtins-vX.X.json：

• 优势：无需修改编辑器代码就能更新内置信息，C#可以通过System.Text.Json或第三方库快速读取解析；
• 信息结构化示例：

{
  "compilerVersion": "1.2.0",
  "builtins": [
    {
      "name": "printf",
      "returnType": "int",
      "params": [{"name": "format", "type": "const char*"}],
      "description": "格式化输出函数",
      "sinceVersion": "1.0.0"
    }
  ]
}

2. 代码内嵌仅适用于极端场景 #

如果目标语言的内置信息极少且几乎不会变更，才考虑硬编码到C#静态类中，比如：

public static class BuiltinsV120
{
    public record FunctionInfo(string Name, string ReturnType, ParamInfo[] Params);
    public record ParamInfo(string Name, string Type);

    public static readonly List<FunctionInfo> Functions = new()
    {
        new FunctionInfo("printf", "int", new[] { new ParamInfo("format", "const char*") })
    };
}

这种方式每次更新都要修改代码、重新编译，扩展性极差，不建议长期使用。

版本化管理方案 #

1. 按编译器版本拆分配置文件 #

给每个编译器版本对应一个独立的配置文件，比如builtins-1.0.json、builtins-1.2.json：

• 编辑器内添加版本选择入口，让用户自行匹配目标编译器版本，加载对应配置文件；
• 配置文件中保留compilerVersion字段，用于校验版本匹配，避免加载错误信息。

2. 自动化提取生成配置 #

写一个轻量工具（比如Python/C++脚本），直接从编译器源码中提取内置信息并生成对应版本的配置文件：

• 例如编译器源码中有builtins.def这类集中定义内置项的文件，工具可以解析该文件的格式，自动输出结构化的JSON/YAML；
• 每次编译器版本更新时，运行工具即可生成新配置，避免手动复制的误差和繁琐。

3. 编辑器内版本切换逻辑 #

• 在C#编辑器中维护版本映射表，用户选择对应编译器版本后，自动加载匹配的配置文件；
• 把配置文件打包到编辑器资源目录，或放在程序根目录下的builtins子文件夹中，方便后续单独更新替换。

额外注意事项 #

• 每次生成配置后，要抽样校验信息准确性（比如对比几个核心内置函数的参数、返回值），确保和编译器实际行为一致；
• 若编译器小版本更新（如1.2.1）未修改内置信息，可直接复用1.2版本的配置文件，无需重复生成。

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