WebStorm中如何在JSDoc里添加可点击的配置文件引用？

有两种实用方法能实现这个需求：

方法一：用@link标签配合正确相对路径 #

WebStorm可以识别JSDoc@link标签里的本地文件路径，只要路径是相对于当前JS文件的正确相对路径，就能被解析为可点击链接。调整注释格式，把路径用<>包裹即可：

/** 
 * 发射真实的Foo导弹。
 * 默认值读取自 {@link ./foo/defaults.yaml}。
 */
async launchFooMissiles() {
   await openHatch()
   const defaults = await readTheDefaults('foo/defaults.yaml')
   ...
}

注意：路径开头的./要根据foo.js和defaults.yaml的实际位置调整，保证WebStorm能定位到目标文件。

方法二：用@see标签指向文件路径 #

和@link的逻辑一致，@see也支持解析本地文件路径，同样用<>包裹路径就能实现点击跳转：

/** 
 * 发射真实的Foo导弹。
 * 默认值读取自 @see <./foo/defaults.yaml>
 */
async launchFooMissiles() {
   await openHatch()
   const defaults = await readTheDefaults('foo/defaults.yaml')
   ...
}

另外，如果你的项目在WebStorm中配置了路径别名，直接使用别名路径也能被识别并跳转。

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