如何在PhpStorm中为自定义路径函数启用自动补全？

要给接收文件路径的自定义函数（比如你的asset函数）实现类似Laravel的文件路径自动补全，只需通过JSDoc注释标记参数类型，让PhpStorm识别出这是一个关联特定目录的路径参数即可，具体操作如下：

方法步骤 #

1. 添加JSDoc注释
   在你的asset函数上方添加JSDoc注释，明确标记path参数为关联指定目录的路径类型：

/**
 * 生成静态资源的完整路径
 * @param {string<path=./public/static>} path 相对于/public/static目录的文件路径
 * @returns {string} 拼接后的完整资源路径
 */
function asset(path: string) {
    return `/public/static/${path}`;
};

2. 关键语法说明

• string<path=./public/static>是触发路径补全的核心：
  • string声明参数基础类型为字符串
  • <path=./public/static>指定该字符串对应./public/static目录下的相对路径，PhpStorm会自动扫描该目录下的所有文件和子目录，在输入参数时提供补全提示
• 若静态资源目录是项目根目录下的绝对路径，可改用PhpStorm内置变量写成string<path=$PROJECT_DIR$/public/static>，$PROJECT_DIR$会自动映射你的项目根目录

3. 验证补全效果
   完成注释后，调用asset()函数并输入路径参数时，PhpStorm就会像Laravel的asset函数一样，弹出对应目录下的文件/目录补全提示。

补充提示 #

• 如果函数是全局可用的，确保PhpStorm能扫描到该函数的定义文件（可在tsconfig.json或jsconfig.json中包含对应文件）
• 若使用纯JavaScript（无TypeScript类型标注），只需去掉函数参数后的: string，JSDoc注释写法保持不变即可

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