插件应用市场
ts-to-markdown
typescript-to-markdown
typescript 类型转为 markdown table,可提取 jsdoc 注释,支持深层嵌套,支持自定义模板。
例子:
复制一段 typescript 类型声明,如下:
interface User {
/**
* @description 用户 id
* @type {number}
*/
id: number;
/**
* @description 昵称
* @type {string}
*/
nickname: string;
// 真实姓名
trueName: string;
// 年龄
age: string;
}
唤起 utools 面板,选择 TypeScript 转 Markdown 插件,会打开插件界面,并且将 typescript
类型声明转为 markdown table的格式,如下:
### User
|参数|说明|类型|必须|
|--|--|--|--|
|id|用户 id|`number`|是|
|nickname|昵称|`string`|是|
|trueName| 真实姓名|`string`|是|
|age| 年龄|`string`|是|
使用场景:基于 typescript 开发的组件库或库,更加方便的生成文档