JSDoc 这就是将 @typedef 标记为 @global 的方式吗?

2024-04-30

只需确保在我们的节点服务器的模块中这是能够使用的正确方法@typedef整个应用程序,而不是在每个需要的模块/文件中重复它。从文档中我无法确定这是否正确,并且是否有人对存储全局 @typedefs 有意见,以便在整个应用程序中使用时很容易找到是否需要更改它们。

/**
 * Universally unique identifier.
 * @global
 * @typedef {string} UUID
 */

这里的答案有点晚了,但我从谷歌上发现了这个问题,所以这就是我自己解决这个问题的方法。希望它对未来的人有所帮助!

我遇到了类似的情况,我有一个typedef在模块中,并希望在应用程序的其他地方使用该类型,而不重新定义该类型。

我去了这样的事情:

myModule.js
/**
 * Universally unique identifier.
 * @typedef {string} UUID
 */
myOtherScript.js

/**
 * @function
 * @param {import('path/to/myModule.js').UUID} uuid
 */
function getByUUID(uuid) { ... }

这并不会使typedef严格全球性,所以你不能这样做@param {UUID} uuid (which would更干净,但是我还没有找到实现此目的的方法)但这种方法适用于我的用例,并且确实比在使用该类型的所有地方重写该类型要好。

有关此主题的更多信息可以在这个 Github 问题 https://github.com/microsoft/TypeScript/issues/25386.

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

JSDoc 这就是将 @typedef 标记为 @global 的方式吗? 的相关文章

随机推荐