如何让PowerShell模块在VS Code中实现参数名称自动提示？

1. 确认模块正确加载 #

• 在VS Code的PowerShell终端执行 Get-Module -Name PsUtils，验证模块已成功加载且版本匹配预期。
• 若未加载，执行 Import-Module .\PsUtils.psd1 -Force 强制重新导入，-Force 参数会覆盖缓存的旧模块信息。

2. 为函数添加标准注释帮助 #

参数提示依赖符合规范的PowerShell注释块，必须包含.PARAMETER节点，示例如下：

function Get-Filelist {
    <#
    .SYNOPSIS
    获取指定目录下的文件列表

    .DESCRIPTION
    支持递归扫描、扩展名过滤的文件列表获取工具

    .PARAMETER Path
    必填参数，指定要扫描的目标目录路径

    .PARAMETER Recurse
    可选开关，启用后递归扫描子目录

    .PARAMETER Extension
    可选参数，按扩展名过滤文件，例如：.txt、.ps1

    .EXAMPLE
    Get-Filelist -Path "C:\Scripts" -Recurse
    递归获取C:\Scripts下所有文件

    .EXAMPLE
    Get-Filelist -Path "C:\Logs" -Extension ".log"
    获取C:\Logs下所有.log格式文件
    #>
    [CmdletBinding()]
    param(
        [Parameter(Mandatory=$true)]
        [string]$Path,
        [switch]$Recurse,
        [string]$Extension
    )

    # 函数核心逻辑
    Get-ChildItem -Path $Path -File -Recurse:$Recurse -Filter "*$Extension"
}

• 必须保留 [CmdletBinding()] 属性，它是高级函数支持注释解析的基础。
• 每个参数对应一个.PARAMETER块，确保PowerShell扩展能解析出参数提示信息。

3. 调整VS Code PowerShell扩展设置 #

• 打开VS Code设置（快捷键Ctrl+,），搜索PowerShell: Code Completion，确保以下选项启用：
  • Enable Completion Prediction：开启自动补全预测
  • Show Advanced Function Help：显示高级函数的详细帮助信息
• 若之前修改过相关设置，可尝试重置为默认值。

4. 清除模块缓存 #

• 执行 Remove-Module PsUtils -Force 卸载模块，然后删除模块缓存文件：
  • 缓存路径通常为 $env:LOCALAPPDATA\Microsoft\Windows\PowerShell\ModuleAnalysisCache
  • 删除该文件夹内所有文件，重启VS Code后重新导入模块。

5. 修正模块清单配置 #

• 打开PsUtils.psd1，确保FunctionsToExport字段明确列出Get-Filelist，避免使用通配符*：

FunctionsToExport = @('Get-Filelist')

• 同时检查ModuleVersion、RootModule等核心字段，确保无语法错误。

6. 更新相关组件 #

• 在VS Code扩展市场检查PowerShell扩展是否有更新，安装最新版本。
• 确保本地PowerShell版本为5.1及以上（推荐7.x版本），旧版本对注释帮助的解析支持有限。

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