如何为函数参数实现代码编辑器自动补全功能？

TypeScript 直接用类型系统实现 #

定义联合类型限定type字段的可选值，再给函数参数指定类型，编辑器自动识别补全：

// 列出所有允许的类型值
type AllowedType = 'someType' | 'anotherType' | 'thirdType';

// 定义配置对象的类型结构
interface FuncOptions {
  type: AllowedType;
}

// 声明函数
function myFunc(str: string, options: FuncOptions) {
  // 函数逻辑
}

// 使用时，输入{ type: '' }就会弹出包含'someType'在内的下拉选项
myFunc('test', { type: '' });

JavaScript 用JSDoc实现无类型语言的补全 #

如果用纯JS，给函数加JSDoc注释标注参数类型，VS Code这类编辑器会识别并给出提示：

/**
 * @param {string} str - 传入的字符串参数
 * @param {{type: 'someType' | 'anotherType' | 'thirdType'}} options - 配置对象
 */
function myFunc(str, options) {
  // 函数逻辑
}

// 输入{ type: '' }时，编辑器会自动弹出可选类型
myFunc('test', { type: '' });

Python 用枚举和类型注解实现 #

借助枚举类限定可选值，配合类型注解，PyCharm、VS Code（需装Pylance插件）都会支持补全：

from enum import Enum

class AllowedType(Enum):
    SOME_TYPE = 'someType'
    ANOTHER_TYPE = 'anotherType'
    THIRD_TYPE = 'thirdType'

def my_func(str_arg: str, options: dict[str, AllowedType]):
    # 函数逻辑
    pass

# 输入{'type': ''}时，编辑器会提示枚举对应的字符串值
my_func('test', {'type': ''})

注意：不同编辑器要确保对应语言服务开启，比如VS Code需启用TypeScript/JSDoc语言服务，Python要安装Pylance插件才能正常触发补全。

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