TypeScript：文档 - JSDoc 参考

以下列表概述了在 JavaScript 文件中使用 JSDoc 注释提供类型信息时当前支持的构造。

注意，任何未在下面明确列出的标签（例如 @async）目前尚不支持。

类型

@type
@param (或 @arg 或 @argument)
@returns (或 @return)
@typedef
@callback
@template
@satisfies

类

属性修饰符 @public, @private, @protected, @readonly
@override
@extends (或 @augments)
@implements
@class (或 @constructor)
@this

文档

文档标签在 TypeScript 和 JavaScript 中都有效。

@deprecated
@see
@link

其含义通常与 jsdoc.app 中给出的标签含义相同或为其超集。以下代码描述了差异，并提供了一些每个标签的示例用法。

注意：您可以使用游乐场来探索 JSDoc 支持。

类型

`@type`

您可以使用“@type”标签引用类型。该类型可以是

原始类型，例如string或number。
在 TypeScript 声明中声明，可以是全局的，也可以是导入的。
在 JSDoc @typedef 标签中声明。

您可以使用大多数 JSDoc 类型语法和任何 TypeScript 语法，从最基本的，例如string 到最先进的，例如条件类型。

js
/**
 * @type {string}
 */
var s;
 
/** @type {Window} */
var win;
 
/** @type {PromiseLike<string>} */
var promisedString;
 
// You can specify an HTML Element with DOM properties
/** @type {HTMLElement} */
var myElement = document.querySelector(selector);
element.dataset.myData = "";Try

@type 可以指定联合类型 - 例如，某事物可以是字符串或布尔值。

js
/**
 * @type {string | boolean}
 */
var sb;Try

您可以使用各种语法来指定数组类型

js
/** @type {number[]} */
var ns;
/** @type {Array.<number>} */
var jsdoc;
/** @type {Array<number>} */
var nas;Try

您还可以指定对象字面量类型。例如，具有属性“a”（字符串）和“b”（数字）的对象使用以下语法

js
/** @type {{ a: string, b: number }} */
var var9;Try

您可以使用字符串和数字索引签名来指定类似于映射和数组的对象，可以使用标准 JSDoc 语法或 TypeScript 语法。

js
/**
 * A map-like object that maps arbitrary `string` properties to `number`s.
 *
 * @type {Object.<string, number>}
 */
var stringToNumber;
 
/** @type {Object.<number, object>} */
var arrayLike;Try

前面的两种类型等效于 TypeScript 类型{ [x: string]: number }和{ [x: number]: any }。编译器理解这两种语法。

您可以使用 TypeScript 或 Google Closure 语法来指定函数类型

js
/** @type {function(string, boolean): number} Closure syntax */
var sbn;
/** @type {(s: string, b: boolean) => number} TypeScript syntax */
var sbn2;Try

或者您也可以使用未指定的Function类型

js
/** @type {Function} */
var fn7;
/** @type {function} */
var fn6;Try

Closure 中的其他类型也适用

js
/**
 * @type {*} - can be 'any' type
 */
var star;
/**
 * @type {?} - unknown type (same as 'any')
 */
var question;Try

强制转换

TypeScript 从 Google Closure 借用了强制转换语法。这使您可以通过在任何带括号的表达式之前添加@type标签将类型强制转换为其他类型。

js
/**
 * @type {number | string}
 */
var numberOrString = Math.random() < 0.5 ? "hello" : 100;
var typeAssertedNumber = /** @type {number} */ (numberOrString);Try

您甚至可以像 TypeScript 一样强制转换为const

js
let one = /** @type {const} */(1);Try

导入类型

您可以使用导入类型从其他文件导入声明。此语法是 TypeScript 特定的，与 JSDoc 标准不同

js
// @filename: types.d.ts
export type Pet = {
  name: string,
};
 
// @filename: main.js
/**
 * @param {import("./types").Pet} p
 */
function walk(p) {
  console.log(`Walking ${p.name}...`);
}Try

导入类型可以在类型别名声明中使用

js
/**
 * @typedef {import("./types").Pet} Pet
 */
 
/**
 * @type {Pet}
 */
var myPet;
myPet.name;Try

如果不知道类型，或者类型很大且难以键入，可以使用导入类型来获取模块中值的类型

js
/**
 * @type {typeof import("./accounts").userAccount}
 */
var x = require("./accounts").userAccount;Try

`@param` 和 `@returns`

@param 使用与 @type 相同的类型语法，但添加了参数名称。参数也可以通过将名称用方括号括起来来声明为可选的

js
// Parameters may be declared in a variety of syntactic forms
/**
 * @param {string}  p1 - A string param.
 * @param {string=} p2 - An optional param (Google Closure syntax)
 * @param {string} [p3] - Another optional param (JSDoc syntax).
 * @param {string} [p4="test"] - An optional param with a default value
 * @returns {string} This is the result
 */
function stringsStringStrings(p1, p2, p3, p4) {
  // TODO
}Try

同样，对于函数的返回类型

js
/**
 * @return {PromiseLike<string>}
 */
function ps() {}
 
/**
 * @returns {{ a: string, b: number }} - May use '@returns' as well as '@return'
 */
function ab() {}Try

`@typedef`、`@callback` 和 `@param`

您可以使用 @typedef 定义复杂类型。类似的语法适用于 @param。

js
/**
 * @typedef {Object} SpecialType - creates a new type named 'SpecialType'
 * @property {string} prop1 - a string property of SpecialType
 * @property {number} prop2 - a number property of SpecialType
 * @property {number=} prop3 - an optional number property of SpecialType
 * @prop {number} [prop4] - an optional number property of SpecialType
 * @prop {number} [prop5=42] - an optional number property of SpecialType with default
 */
 
/** @type {SpecialType} */
var specialTypeObject;
specialTypeObject.prop3;Try

您可以在第一行使用 object 或 Object。

js
/**
 * @typedef {object} SpecialType1 - creates a new type named 'SpecialType1'
 * @property {string} prop1 - a string property of SpecialType1
 * @property {number} prop2 - a number property of SpecialType1
 * @property {number=} prop3 - an optional number property of SpecialType1
 */
 
/** @type {SpecialType1} */
var specialTypeObject1;Try

@param 允许类似的语法用于一次性类型规范。请注意，嵌套属性名称必须以参数的名称为前缀

js
/**
 * @param {Object} options - The shape is the same as SpecialType above
 * @param {string} options.prop1
 * @param {number} options.prop2
 * @param {number=} options.prop3
 * @param {number} [options.prop4]
 * @param {number} [options.prop5=42]
 */
function special(options) {
  return (options.prop4 || 1001) + options.prop5;
}Try

@callback 类似于 @typedef，但它指定函数类型而不是对象类型

js
/**
 * @callback Predicate
 * @param {string} data
 * @param {number} [index]
 * @returns {boolean}
 */
 
/** @type {Predicate} */
const ok = (s) => !(s.length % 2);Try

当然，所有这些类型都可以使用 TypeScript 语法在一行 @typedef 中声明

js
/** @typedef {{ prop1: string, prop2: string, prop3?: number }} SpecialType */
/** @typedef {(data: string, index?: number) => boolean} Predicate */

`@template`

您可以使用 @template 标签声明类型参数。这使您可以创建泛型的函数、类或类型

js
/**
 * @template T
 * @param {T} x - A generic parameter that flows through to the return type
 * @returns {T}
 */
function id(x) {
  return x;
}
 
const a = id("string");
const b = id(123);
const c = id({});Try

使用逗号或多个标签来声明多个类型参数

js
/**
 * @template T,U,V
 * @template W,X
 */

您也可以在类型参数名称之前指定类型约束。列表中只有第一个类型参数受到约束

js
/**
 * @template {string} K - K must be a string or string literal
 * @template {{ serious(): string }} Seriousalizable - must have a serious method
 * @param {K} key
 * @param {Seriousalizable} object
 */
function seriousalize(key, object) {
  // ????
}Try

最后，您可以为类型参数指定默认值

js
/** @template [T=object] */
class Cache {
    /** @param {T} initial */
    constructor(initial) {
    }
}
let c = new Cache()Try

`@satisfies`

@satisfies 提供对 TypeScript 中的后缀运算符 satisfies 的访问。Satisfies 用于声明一个值实现了一个类型，但不会影响值的类型。

js
// @ts-check
/**
 * @typedef {"hello world" | "Hello, world"} WelcomeMessage
 */
 
/** @satisfies {WelcomeMessage} */
const message = "hello world"
        
const message: "hello world"
 
/** @satisfies {WelcomeMessage} */
Type '"Hello world!"' does not satisfy the expected type 'WelcomeMessage'.1360Type '"Hello world!"' does not satisfy the expected type 'WelcomeMessage'.const failingMessage = "Hello world!"
 
/** @type {WelcomeMessage} */
const messageUsingType = "hello world"
             
const messageUsingType: WelcomeMessageTry

类

类可以声明为 ES6 类。

js
class C {
  /**
   * @param {number} data
   */
  constructor(data) {
    // property types can be inferred
    this.name = "foo";
 
    // or set explicitly
    /** @type {string | null} */
    this.title = null;
 
    // or simply annotated, if they're set elsewhere
    /** @type {number} */
    this.size;
 
    this.initialize(data); // Should error, initializer expects a string
  }
  /**
   * @param {string} s
   */
  initialize = function (s) {
    this.size = s.length;
  };
}
 
var c = new C(0);
 
// C should only be called with new, but
// because it is JavaScript, this is allowed and
// considered an 'any'.
var result = C(1);Try

它们也可以声明为构造函数；使用 @constructor 以及 @this 来表示 this。

属性修饰符

@public、@private 和 @protected 的工作方式与 TypeScript 中的 public、private 和 protected 完全相同

js
// @ts-check
 
class Car {
  constructor() {
    /** @private */
    this.identifier = 100;
  }
 
  printIdentifier() {
    console.log(this.identifier);
  }
}
 
const c = new Car();
console.log(c.identifier);
Property 'identifier' is private and only accessible within class 'Car'.2341Property 'identifier' is private and only accessible within class 'Car'.Try

@public 始终隐含，可以省略，但表示属性可以从任何地方访问。
@private 表示属性只能在包含的类中使用。
@protected 表示属性只能在包含的类及其所有派生子类中使用，但不能在包含类的不同实例上使用。

@public、@private 和 @protected 在构造函数中不起作用。

`@readonly`

@readonly 修饰符确保属性仅在初始化期间写入。

js
// @ts-check
 
class Car {
  constructor() {
    /** @readonly */
    this.identifier = 100;
  }
 
  printIdentifier() {
    console.log(this.identifier);
  }
}
 
const c = new Car();
console.log(c.identifier);Try

`@override`

@override 的工作方式与 TypeScript 中相同；将其用于覆盖基类方法的方法。

js
export class C {
  m() { }
}
class D extends C {
  /** @override */
  m() { }
}Try

在 tsconfig 中设置 noImplicitOverride: true 以检查覆盖。

`@extends`

当 JavaScript 类扩展泛型基类时，没有 JavaScript 语法用于传递类型参数。@extends 标签允许这样做。

js
/**
 * @template T
 * @extends {Set<T>}
 */
class SortableSet extends Set {
  // ...
}Try

请注意，@extends 仅适用于类。目前，构造函数无法扩展类。

`@implements`

同样，没有 JavaScript 语法用于实现 TypeScript 接口。@implements 标签的工作方式与 TypeScript 中相同。

js
/** @implements {Print} */
class TextBook {
  print() {
    // TODO
  }
}Try

`@constructor`

编译器根据 this 属性赋值推断构造函数，但如果添加 @constructor 标签，可以使检查更严格，建议更好。

js
/**
 * @constructor
 * @param {number} data
 */
function C(data) {
  // property types can be inferred
  this.name = "foo";
 
  // or set explicitly
  /** @type {string | null} */
  this.title = null;
 
  // or simply annotated, if they're set elsewhere
  /** @type {number} */
  this.size;
 
  this.initialize(data);
Argument of type 'number' is not assignable to parameter of type 'string'.2345Argument of type 'number' is not assignable to parameter of type 'string'.}
/**
 * @param {string} s
 */
C.prototype.initialize = function (s) {
  this.size = s.length;
};
 
var c = new C(0);
c.size;
 
var result = C(1);
Value of type 'typeof C' is not callable. Did you mean to include 'new'?2348Value of type 'typeof C' is not callable. Did you mean to include 'new'?Try

注意：错误消息仅在具有 JSConfig 和 checkJs 启用的 JS 代码库中显示。

使用 @constructor，this 在构造函数 C 内部进行检查，因此您将获得 initialize 方法的建议，并且如果传递数字，则会收到错误。您的编辑器也可能会在您调用 C 而不是构造它时显示警告。

不幸的是，这意味着既可调用又可作为构造函数的函数不能使用 @constructor。

`@this`

编译器通常可以在有上下文的情况下弄清楚 this 的类型。当它没有时，您可以使用 @this 显式指定 this 的类型。

js
/**
 * @this {HTMLElement}
 * @param {*} e
 */
function callbackForLater(e) {
  this.clientHeight = parseInt(e); // should be fine!
}Try

文档

`@deprecated`

当一个函数、方法或属性被弃用时，你可以通过在它上面添加 /** @deprecated */ JSDoc 注释来让用户知道。该信息会在代码补全列表中显示，并且作为编辑器可以特殊处理的建议诊断信息。在像 VS Code 这样的编辑器中，弃用的值通常以删除线样式显示 ~~像这样~~。

js
/** @deprecated */
const apiV1 = {};
const apiV2 = {};
 
apiV;
   apiV1
apiV2
 
 Try

`@see`

@see 允许你链接到程序中的其他名称

ts
type Box<T> = { t: T }
/** @see Box for implementation details */
type Boxify<T> = { [K in keyof T]: Box<T> };Try

一些编辑器会将 Box 变成一个链接，方便你跳转到它并返回。

`@link`

@link 与 @see 相似，但它可以用于其他标签中

ts
type Box<T> = { t: T }
/** @returns A {@link Box} containing the parameter. */
function box<U>(u: U): Box<U> {
  return { t: u };
}Try

其他

`@enum`

@enum 标签允许你创建一个对象字面量，其成员都是指定类型的。与 JavaScript 中的大多数对象字面量不同，它不允许其他成员。@enum 旨在与 Google Closure 的 @enum 标签兼容。

js
/** @enum {number} */
const JSDocState = {
  BeginningOfLine: 0,
  SawAsterisk: 1,
  SavingComments: 2,
};
 
JSDocState.SawAsterisk;Try

请注意，@enum 与 TypeScript 的 enum 非常不同，并且比它简单得多。但是，与 TypeScript 的枚举不同，@enum 可以具有任何类型

js
/** @enum {function(number): number} */
const MathFuncs = {
  add1: (n) => n + 1,
  id: (n) => -n,
  sub1: (n) => n - 1,
};
 
MathFuncs.add1;Try

`@author`

你可以使用 @author 指定项目的作者

ts
/**
 * Welcome to awesome.ts
 * @author Ian Awesome <[email protected]>
 */Try

请记住用尖括号包围电子邮件地址。否则，@example 将被解析为一个新的标签。

其他支持的模式

js
var someObj = {
  /**
   * @param {string} param1 - JSDocs on property assignments work
   */
  x: function (param1) {},
};
 
/**
 * As do jsdocs on variable assignments
 * @return {Window}
 */
let someFunc = function () {};
 
/**
 * And class methods
 * @param {string} greeting The greeting to use
 */
Foo.prototype.sayHi = (greeting) => console.log("Hi!");
 
/**
 * And arrow function expressions
 * @param {number} x - A multiplier
 */
let myArrow = (x) => x * x;
 
/**
 * Which means it works for function components in JSX too
 * @param {{a: string, b: number}} props - Some param
 */
var fc = (props) => <div>{props.a.charAt(0)}</div>;
 
/**
 * A parameter can be a class constructor, using Google Closure syntax.
 *
 * @param {{new(...args: any[]): object}} C - The class to register
 */
function registerClass(C) {}
 
/**
 * @param {...string} p1 - A 'rest' arg (array) of strings. (treated as 'any')
 */
function fn10(p1) {}
 
/**
 * @param {...string} p1 - A 'rest' arg (array) of strings. (treated as 'any')
 */
function fn9(p1) {
  return p1.join();
}Try

不支持的模式

对象文字类型中属性类型上的后缀等于号不会指定可选属性

js
/**
 * @type {{ a: string, b: number= }}
 */
var wrong;
/**
 * Use postfix question on the property name instead:
 * @type {{ a: string, b?: number }}
 */
var right;Try

可空类型只有在 strictNullChecks 启用时才有意义

js
/**
 * @type {?number}
 * With strictNullChecks: true  -- number | null
 * With strictNullChecks: false -- number
 */
var nullable;Try

TypeScript 原生语法是联合类型

js
/**
 * @type {number | null}
 * With strictNullChecks: true  -- number | null
 * With strictNullChecks: false -- number
 */
var unionNullable;Try

非空类型没有意义，并且被视为其原始类型

js
/**
 * @type {!number}
 * Just has type number
 */
var normal;Try

与 JSDoc 的类型系统不同，TypeScript 只允许您将类型标记为包含 null 或不包含 null。没有明确的非空性 - 如果 strictNullChecks 启用，则 number 不可空。如果它被禁用，则 number 可空。

不支持的标签

TypeScript 会忽略任何不支持的 JSDoc 标签。

以下标签存在支持它们的未解决问题

@const (问题 #19672)
@inheritdoc (问题 #23215)
@memberof (问题 #7237)
@yields (问题 #23857)

JSDoc 参考

类型

类

文档

其他

类型

@type

强制转换

导入类型

@param 和 @returns

@typedef、@callback 和 @param

@template

@satisfies

类

属性修饰符

@readonly

@override

@extends

@implements

@constructor

@this

文档

@deprecated

@see

@link

其他

@enum

@author

其他支持的模式

不支持的模式

不支持的标签

类型检查 JavaScript 文件

从 .js 文件创建 .d.ts 文件

JavaScript 基础

使用 JavaScript 的函数

使用类

现代 JavaScript

外部 API

帮助使用 JavaScript

基本类型

类型基本类型

元类型

语言

语言扩展