TypeDoc 是什么?

TypeDoc 是 TypeScript 的文档生成器,它读取 TypeScript 源码、 解析其中包含的注释,最后为你的代码生成一个静态的文档网站。

TypeDoc 会为所有被导出(export)的部分生成文档。也会跟进二次导出(re-exports),读取其它文件中包含的文档

// $ npx typedoc src/index.ts

/** 生成文档! */
export function direct() {
return 1;
}

// 也会生成文档。
export { indirect } from "./other";

// 不会为其生成文档,因为此模块不会暴露给调用者。
function localHelper() {}

开始吧