文档测试

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

这确保了您文档中的示例是最新的且可工作的。

基本思想是

/**
 * # Examples
 *
 * ```ts
 * const x = 42;
 * ```
 */

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

• js
• jsx
• ts
• tsx

如果没有指定语言标识符，则语言将从代码块提取的源文档的媒体类型推断。

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

要记录您的导出，请使用相对路径说明符导入模块

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