跳到主要内容

文档测试

Deno 支持对您的文档示例进行类型检查。

这可以确保您的文档中的示例是最新的并且能够正常工作。

基本思想是这样的:

/**
* # 示例
*
* ```ts
* const x = 42;
* ```
*/

三个反引号标记了代码块的开始和结束,语言由语言标识属性确定,可以是以下任何一种:

  • js
  • jsx
  • ts
  • tsx

如果未指定语言标识符,则语言将根据从源文档中提取的代码块的媒体类型进行推断。

如果此示例位于名为 foo.ts 的文件中,运行 deno test --doc foo.ts 将提取此示例,然后将其类型检查为一个独立的模块,与正在记录的模块位于相同的目录中。

要记录您的导出内容,请使用相对路径标识符导入模块:

/**
* # 示例
*
* ```ts
* import { foo } from "./foo.ts";
* ```
*/
export function foo(): string {
return "foo";
}