travelcode-tsdoc

介绍

本插件应用于typedoc注释文档生成工具,目的在于减少命令行参数输入

安装

因为改变了调用typedoc命令的方式,所以不再依赖typedoc,需要手动安装typedoc

• 全局安装
  npm install -g typescript
npm install -g typedoc npm install -g travelcode-jsdoc
• 局部安装
  npm install -save-dev typescript
npm install --save-dev typedoc npm install -save-dev travelcode-jsdoc

使用

全局安装的情况下,在项目根目录下运行如下命令:
tsdoc 运行配置在typedoc.json文件中的typedoc命令行命令
tsdoc --cfgfile filePath自由指定配置了typedoc命令的文件
tsdoc --init 初始化一个空的typedoc.json文件
tsdoc --init schema 初始化一个typedoc.json文件,并且在头部添加一行schema引用
typedoc 运行原生的typedoc命令,该命令不会经过tsdoc设置

编辑器配置

Visual Studio Code配置:
文件-首选项-设置搜索json:schemas,点击在setting.json中编辑,添加如下代码:

  "json.schemas": [
    {
      "fileMatch": [
        "typedoc.json"
      ],
      "url": "http://travelcoding.xyz/schema/typedoc.schema.json"
    }
  ],

获取typedoc.json的schema支持