日记

A 类 联合来文文件 用于小项目的模板,可以发送Markdown Docs或TypeScript类型.

不建议使用,因为它只执行作者使用的JSDoc的几个部分。 随着TS工具的不断完善,项目可能会消亡.

设置

像其他JSDoc模板一样设置这个. 安装软件包开始 :

npm i -D @borgar/jsdoc-tsmd

然后添加一个配置文件, 它可能看起来是这样的 :

{
  "source": {
    "includePattern": ".+\\.js(doc|x)?$",
    "excludePattern": "((^|\\/|\\\\)_|spec\\.js$)"
  },
  "opts": {
    "template": "node_modules/@borgar/jsdoc-tsmd",
    "destination": "console",
  }
}

运行 jsdoc -c myconfig.json src ,然后释放一些 Markdown 文档(因为来源中有有效的 jsdoc 注释)。 参见以下关于如何生成 TypeScript 类型声明的选项.

选项 :

一般来说,参考JSDoc的 关于如何配置的文档 但这些选项具有特殊意义:

• destination - 何处保存已发布的文本,使用 "console" 将记录输出到控制台.
• output - 把它设定为 "typescript" 以发出 TypeScript 类型声明,而不是 Markdown docs .
• validate - 制作类型声明时,输出会通过 TypeScript 运行以验证它,如果您喜欢生活在边缘,您可以设定为 false 跳过这一步.

许可证

麻省理工学院