首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何在打字本中记录合并类型?

如何在打字本中记录合并类型?
EN

Stack Overflow用户
提问于 2021-01-28 16:38:21
回答 1查看 498关注 0票数 4

如何在类型记录中记录Union类型,以便typedoc能够提取/显示相关信息?下面是一个JSDoc引用,但是有TSDoc引用吗?

示例

代码语言:javascript
复制
/**
 * Search parameters
 * These comments are not picked up, I generate blank page
 */
export type SearchParams = string | string[][] | Record<string, string>;

/**
 * Query parameters
 * These comments are not picked up, I generate blank page 
 */
export type QueryParams = SearchParams | Record<string, string | string[]>;

它们只是因为出口而被捡起来,但是没有任何信息产生。(docfx@2.56.6typedoc@0.19.2type2docfx@0.10.5)

编辑:有任何方法可以使用上面的工具为这些类型生成文档吗?

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2021-02-03 11:55:26

看起来,不管我们在那里放置了什么注释,DocFx都无法为类型别名和函数生成页面,而只能为类、接口等生成页面。至少在指定的版本。

我已经通过检查生成的*.json输出文件和生成的*.yml文件来确认这一点。所有提到的文件都包含元数据,但是docfx没有以正确的方式为它们生成html页面。

现在,我只使用typedoctypedoc-plugin-markdown来生成文档,并以自己的身份正常工作。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/65941422

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档