好用的文档工具compodoc

 一、安装compodoc

npm install --save-dev @compodoc/compodoc

没有使用全局安装，生成文档的时候，需要执行 ./node_modules/.bin/compodoc -p tsconfig.app.json -s -r 9000 

 

编辑package.json，在scripts选项里，添加下面这段：

"doc": "npx compodoc -p tsconfig.app.json -n \"Angular-Admin\""

默认使用的是8080端口，如果要使用自定义端口，如：9000，使用 -r 9000 即可

使用中文语言，加 --language=zh-CN 即可

默认的theme主题是gitbook，使用--theme=laravel，指定使用laravel自定义主题

更多compodoc的参数选项，可以参考这里https://compodoc.app/guides/options.html

 

编辑tsconfig.app.json

把下面的的配置

  "include": [
    "src/**/*.d.ts"
  ]

改成如下的配置

  "include": ["src/**/*.ts"],
  "exclude": ["src/test.ts", "src/**/*.spec.ts", "src/app/file-to-exclude.ts"]

不改的话，下面生成文档的内容是空的，这里一定要先把配置修改正确！

 

二、生成文档

npm run doc

这会在项目根目录下生成文件夹名为doc的文档目录，在doc目录下就是生成的文档了 

 

参考资料：

https://compodoc.app/

https://www.codercto.com/a/85646.html

https://stackoverflow.com/questions/49631438/need-to-change-port-for-document-opening-in-compodoc

http://www.semlinker.com/ng-compodoc-intro/

https://www.jianshu.com/p/00bb9d845200

https://www.796t.com/post/NzI1a3E=.html

https://jonny-huang.github.io/angular/training/23_compodoc/

https://juejin.cn/post/6844903866060767240