typedoc 快速使用

 对外发布的项目都会有配套的API文档，通常情况都是由相应工具扫描源码生成可阅读的文档信息，对于Typescript 的这门语言，typedoc 是常用的API文档生成工具。

(官方文档)

环境配置

一、npm 环境工具
安装typedoc 到当前目录

$ npm i typedoc --save-dev

打印版本检查安装情况,能看到版本信息说明装好了

$ npx typedoc --version

二、typedoc.json 配置
新建 typedoc.json 文件到当前目录

• 这里假定 ts项目目录为 ../src
• entryPoints 选项配置入口 .ts 文件
• out 选项配置生成输入目录

{
    "entryPoints": [
        "../src/anyCode.ts"
    ],
    "out": "../docs"
}

执行生成

• 使用 --tsconfig选项，生成整个项目的doc

$ npx typedoc --tsconfig ../src/tsconfig.json

本机测试环境

• node 版本 16.15.1
• typedoc 版本 0.22
• tsc 版本 4.0.5