在 JSDoc 中添加本地 Markdown 文件的链接

Question

我有这个用 Typescript Jsdocs 键入的函数：

/**
 * my function description... 
 * @see {@link ../docs/csrf-issues.md} 
 * @param httpClientRef : AxiosInstance
 * @return {Promise<void>}
 */
export const httpClientSetCsrfToken = async (httpClientRef) => {...}

现在我希望阅读 JSDoc 的其他开发人员可以单击该链接：

@see {@link ../docs/csrf-issues.md}

并轻松完成。

如果我使用像这样的外部 http 链接，这会起作用：

但它不适用于我的存储库中文件的相对链接。

有没有办法引用相对路径文件作为文档帮助？

（在 WebStorm 和 VSCode 上也是同样的问题）

Answer 1

我使用导入的模块测试了此方法并且它有效：

// file: newFunction.ts
export function newFunction() {}

//file: deprecatedFunction.ts
import type { newFunction } from "./newFunction"

/** @deprecated use {@link newFunction} */
function deprecatedFunction() {}

来源：https://github.com/microsoft/TypeScript/issues/47718#issuecomment-2185274842

还有多种方法可以将其链接到讨论中。