CocosCreator + Vscode + Ts 代码注释生成文档，利用typedoc

需求： 脚本的代码注释，生成为文档

基本搭建环境： （cocoscreator 2.4.x + vscode + ts） 、（nodejs + npm)

步骤：

1、安装typedoc：

npm install -g typedoc

2、项目根目录添加/创建 typedoc.json 文件

3、然后再项目 tsconfig.json 文件 加入 （4步骤报错可选）

"downlevelIteration": true

4、配置 typedoc.json, 参考如下

`

{

"name": "api说明", // 文档项目名称

"entryPoints": ["./assets//*.ts"], // TypeScript文件的入口点，通常是存放您的脚本的目录

"tsconfig":"./tsconfig.json", // 指定config路径

"out": "docs", // 文档输出目录-自己创建，可以自定义

// "mode": "file",

"theme": "default",// 默认主题

// // "includes": "path/to/your/customIncludes", // 可选，如果您有自定义的文档部分，可以指定其路径

"exclude": [

"/node_modules/", // 排除node_modules文件夹

"/build/", // 排除build文件夹，如果有的话

"/*.d.ts" // 排除所有的TypeScript声明文件

],

}

`

5、项目终端运行 typedoc 即可

6、生成后运行文件里的 index.html即可看到注释

其他可遇到的问题：

1、如果版本问题可以用 ： npm install -g typedoc@latest