JSDoc

类型补全问题

在开发过程中，有时会遇到类型补全的问题。这个问题并非由ProbeJS直接导致，而是由于KubeJS各个事件返回的参数与JavaScript的弱类型特性所引发。通过合理使用JSDoc 标记，可以在一定程度上优化这一问题。

如果你是想要更深入地学习JSDoc，可以在文档内撰写好相关内容前查看这一文档 。

例如在这个文档 中，虽然可以使用 potionEffects 来修改实体的药水效果，但在尝试获取时可能会遇到问题：

ItemEvents.entityInteracted(event => {
    const { entity, hand } = event;
    if (hand !== 'main_hand') return;
    entity.potionEffects.add('minecraft:night_vision', 200, 0, false, true);
})

可以看到，potionEffects并没有正确显示Twoslash提供的类型提示。

这是因为potionEffects是Internal.LivingEntity的方法，同时

ItemEvents.entityInteracted 提供的参数类型为 Entity，便导致了无法正确为event.entity补全potionEffects的情况。

由于KubeJS的事件设计，这种问题在KubeJS的魔改中较为常见。

更具体的内容可以参照类篇章

然而，通过使用 JSDoc 标记变量类型可以缓解这一问题：

ItemEvents.entityInteracted(event => {
    const { entity } = event;
    /** @type {Internal.LivingEntity} */
    let livingentity = entity;
    livingentity.potionEffects.add('minecraft:night_vision', 200, 0, false, true);
})

可以看到，现在potionsEffects的类型可以正常显示。

该方式能够让类型补全更加准确，从而改进开发体验。

基础JSDoc用法

标注变量类型

在JavaScript中，由于其动态类型特性，变量的类型并不会在代码中明确声明。但通过JSDoc，你可以为变量显式声明类型，从而获得更好的类型提示支持。其基本语法如下：

/**
 * @type {string}
 */
let myString = 'Hello World';

通过这种方式，编辑器会将myString识别为string类型，并提供相应的代码补全提示。

通常来说，这种方法能够适用于大部分KubeJS开发中遇到的类型问题。

标注函数参数与返回值

同样，JSDoc还可以用于为函数的参数和返回值标注类型。例如：

/**
 * 计算两个数的和
 * @param {number} a - 第一个数字
 * @param {number} b - 第二个数字
 * @returns {number} 两数之和
 */
function add(a, b) {
    return a + b;
}

通过这种方式，JSDoc可以为你定义更加复杂的类型结构，能为函数规范格式，便于复杂的开发。

进阶JSDoc用法

泛型类型

如果你在处理泛型类型^[1]时，需要使用JSDoc来描述这些结构。例如，对于一个可以返回T类型的函数，可以这样定义：

/**
 * 返回数组中的第一个元素
 * @template T
 * @param {T[]} arr - 传入的数组
 * @returns {T} 数组的第一个元素
 */
function first(arr) {
    return arr[0];
}

通过@template标签，你可以为函数指定泛型类型，使得代码更具通用性。

this上下文

在某些场景下，尤其是在面向对象的编程中，this的上下文可能不够明确。通过JSDoc，你可以为this标注类型(尽管KubeJS只有阉割的类)：

/**
 * @this {Internal.Player}
 */
function logUsername() {
    console.log(this.username);
}

JSDoc实际应用

这一章节将简要列举一些具体应用来帮助各位理解JSDoc起到的关键作用。

Param

这种情况通常出现在需要为箭头函数的参数指定具体类型时。一般来说，箭头函数的参数类型往往被定义为各种类的父类，这可能导致在编写代码时，得到的类型提示和补全少于预期的情况。

你还不需要知道父类意味着什么，只需知道为了解决这个问题，我们可以使用 JSDoc 注释，将默认的Internal.Item类型显式地标注为更具体的Internal.SwordItem。

这样不仅可以获得更加精准的类型提示，还能提升代码的可读性和可维护性。

kubejs

ItemEvents.modification(event=>{
    event.modify("diamond_sword", item=>{
        item.getTier()
    })
})

kubejs

ItemEvents.modification(event=>{
    event.modify("diamond_sword",/**@param {Internal.SwordItem} item */ item=>{
        item.getTier()
    })
})

Type

在某些情况下，JavaScript的类型推断可能不足以提供准确/明确的类型提示。

这时候可以通过使用 @type注释来明确指定变量的类型，从而获得更精确的类型信息和代码提示。

kubejs

ItemEvents.entityInteracted(event => {
    const { entity, target, hand, server, level } = event;
    if (hand !== 'main_hand') return;
    entity.potionEffects.add('minecraft:night_vision', 200, 0, false, true);
})

kubejs

ItemEvents.entityInteracted(event => {
    const { entity, target, hand, server, level } = event;
    /**
     * @type {Internal.LivingEntity} 这是一个改变了类型的变量。
     */
    let livingentity = entity;
    entity.potionEffects.add('minecraft:night_vision', 200, 0, false, true);
    livingentity.potionEffects.add('minecraft:night_vision', 200, 0, false, true);
})

Q&A

• Q: JSDoc能改变一个变量/参数具体的类型吗？

答案是否定的，JSDoc所起到的只是标记作用，这意味着你必须明确自己要标记的参数的类型，且在该事件中的确作为所标记的类型存在，才能够使用JSDoc来重新标记类型。JSDoc 的作用仅仅是为开发工具提供类型提示，而不会改变 JavaScript 运行时的实际类型。

• Q: JSDoc 可以自动推断类型吗？

不可以，JSDoc 只能提供你手动指定的类型信息，不能自动推断变量或参数的类型。你需要明确使用@type、@param、@returns等标签来告知开发工具具体的类型。对于推断类型的功能，TypeScript 提供了更好的支持。

贡献者

M1hono

页面历史

最后编辑于 大约 2 个月前

查看完整历史

6a1dc79 - Update Twoslash config and 1.21 LootJS en translation.

2262553 - Add QQ & Discord icon. Improve ProbeJS and JSDoc doc. Start MBD2 Doc.

6f30d01 - Change Index files, Add rules, Improve Nav bar, Make noguide default balue true, Fix Summary Path Error. I died.

db48e7a - Change JSDoc. Improve text structure and Add 'Q&A' Part.

2fdca78 - Summary Fix. Fix Gumeng Doc's Summary. Start ProbeJS Tutorial. JSDoc Tutorial.

---

1. 泛型（Generic）是指在编程语言中可以在编写代码时不确定具体数据类型，而在实际使用时才明确具体类型的编程技术。
   这种机制允许函数、类或接口在处理不同类型的数据时保持通用性，避免重复编写同样逻辑但只适用于特定类型的代码。
   KubeJS的开发一般用不到这一部分。 ↩︎