typedoc参数列表解释

输入选项

名称说明
entryPoints这个选项用于指定Typedoc生成的文档的入口点。入口点是指被文档化的对象的定义所在的文件或模块。通过指定入口点,Typedoc可以找到被文档化的对象,并生成相应的文档。这个选项可以接受一个字符串或字符串数组,用于指定一个或多个入口文件的路径
entryPointStrategy指定处理入口点的策略,入口点是指被文档化的对象的定义所在的文件或模块。TypeDoc通过检查这些文件的导出并根据这些导出创建文档
exclude用于指定应该从编译过程中排除的文件或文件夹。这意味着,当Typedoc处理TypeScript源代码时,它将忽略这些指定的文件或文件夹,不会将它们包含在生成的文档中。
externalPattern用于指定用于识别外部模块的正则表达式模式。默认情况下,它会把项目中所有导入的模块都视为内部模块,并生成相应的文档。但是,有些模块可能是从外部引入的,并不需要生成文档。这时,就可以使用externalPattern选项来指定哪些模块应该被视为外部模块,不包含在生成的文档中
excludeExternals用于指定是否排除外部模块,excludeExternals选项可以设置为true或false
excludeNotDocumentedexcludeNotDocumented选项可以设置为true或false。如果设置为true,Typedoc将只记录具有文档注释的符号,而忽略其他未注释的符号。如果设置为false或未设置该选项,Typedoc会记录所有解析出来的符号,包括未注释的符号
excludeInternal用于指定是否排除内部模块,excludeInternal选项可以设置为true或false。如果设置为true,Typedoc将排除所有内部模块,只生成可公开访问的模块的文档。如果设置为false或未设置该选项,Typedoc会将所有可导出的模块都包含在生成的文档中。
excludePrivate用于指定是否排除私有成员,excludePrivate选项可以设置为true或false。如果设置为true,Typedoc将排除所有私有成员,只生成非私有成员的文档。如果设置为false或未设置该选项,Typedoc会将所有解析出来的成员都包含在生成的文档中。
excludeProtected用于指定是否排除受保护的成员,excludeProtected选项可以设置为true或false。如果设置为true,Typedoc将排除所有受保护的成员,只生成非受保护成员的文档。如果设置为false或未设置该选项,Typedoc会将所有解析出来的成员都包含在生成的文档中
media注入多媒体文件地址
includes当Typedoc生成文档时,它会查找指定的文件或文件夹,并将这些文件或文件夹包含在生成的文档中,注入其他文档地址, 例如 markdown 文件

输出选项

名称说明
out文档输出目录
jsonTypedoc可以生成一个JSON文件,其中包含了TypeScript源代码中的注释和元数据,以及与它们相关联的文档信息。这个JSON文件可以被其他工具读取和使用,以进一步处理和展示文档
pretty用于指定是否为生成的文档添加格式化和美化
emit当设置为true时,"emit"选项将使Typedoc生成文档并输出到指定的输出格式(如HTML、JSON等)。如果设置为false,Typedoc将不会生成任何输出文件,但仍然会执行文档解析和生成过程。
themedefault,minimal,path
customCss支持通过CSS来自定义文档的外观和样式。在TypeDoc中,可以使用自定义CSS文件来覆盖默认的样式,并按照自己的需要进行定制
markedOptions用于指定传递给Marked库的选项。Marked库是一个用于将Markdown文本转换为HTML的JavaScript库,TypeDoc使用它来将注释解析为HTML文档。
name名称
includeVersion是否包含版本号
disableSources用于指定是否禁用源代码映射(source map)的生成
basePath指定用于显示文件路径的基本路径。如果未设置,TypeDoc将通过取所有源文件的最低公共目录进行猜测。
excludeTags指定在解析文档注释时应从中移除的标记。如果你的项目使用apiDoc来记录RESTful Web API,这个功能很有用。
readmereadme文本路径或None
cname创建一个CNAME文件在指定的输出目录,并填写指定的文本
htmlLang在TypeDoc的HTML输出中设置lang属性,默认为en,结果为<html lang=“en”>。
hideGenerator不要在页面末尾打印 TypeDoc 链接。默认为 false。
searchInComments在生成的文档站点中启用搜索注释文本的功能。注意:启用此选项将增加您的搜索索引的大小,在有很多长评论的项目中可能会增加一个数量级的大小

注释选项

名称说明
commentStyle确定 TypeDoc 将使用的注释类型。
blockTags覆盖 TypeDoc 的支持块标记,对任何未在此处列出的标记发出警告。

组织选项

名称说明
categorizeByGroup此标志按组(在属性、方法等内部)对反射进行分类。要将同一类别的属性和方法分组在一起,请将此标志设置为false。默认为true。
defaultCategory为默认类别设置名称,当页面中的某些元素被分类时使用该默认类别。默认值为“其他”
categoryOrder这个数组选项允许覆盖类别在中的显示顺序。一个由 * 组成的字符串表示不在列表中的类别应该出现在哪里。默认情况下,类别按字母顺序显示。如果发现未知类别,它们将默认列在最后。
sort显示排序

通用配置

名称说明
watch监视源文件更改
preserveWatchOutput默认情况下,–watch在编译步骤之间清除屏幕。如果指定了–preserveWatchOutput,则禁用此行为。
  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
TypeDoc是一个用于生成JavaScript和TypeScript脚本的文档的工具。它提供了一个命令行界面和一个软件开发包(SDK)来帮助开发者生成详细的代码文档。使用TypeDoc SDK可以很方便地将项目代码转换为易于阅读的HTML文档,以便更好地了解代码结构和功能。 通过TypeDoc SDK,开发者可以配置脚本文档的输出方式、主题样式、源文件位置等。使用TypeScript编写的项目可以直接从项目源码生成文档,而对于JavaScript项目,需要先将其编译为TypeScript,然后再生成文档。 TypeDoc SDK支持文档的自定义化,开发者可以使用一些注释标记来为代码添加描述、类型和标签等信息,用于生成更加详细和准确的文档。此外,开发者还可以自定义生成文档中的导航栏、侧边栏、主题样式等,使生成的文档更符合项目的风格。 使用TypeDoc SDK生成脚本文档有助于团队合作和项目维护。生成的文档可以提供项目内部和外部的开发者们一个清晰和一致的代码文档,减少交流和理解代码的困难。同时,文档中的代码示例、图表、接口描述等可以帮助新手快速上手项目,也可以作为项目的技术文档供参考和分享。 总之,TypeDoc SDK是一个强大的工具,可以帮助开发者轻松地生成JavaScript和TypeScript脚本的文档。通过使用TypeDoc SDK,可以提高团队的协作效率,提升项目的可维护性和可读性。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

李卓书

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值