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,则禁用此行为。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/87692.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

K-最近邻算法

一、说明 KNN算法是一个分类算法,基本数学模型是距离模型。K-最近邻是一种超级简单的监督学习算法。它可以应用于分类和回归问题。虽然它是在 1950 年代引入的,但今天仍在使用。然而如何实现,本文将给出具体描述。 来源:维基百科 …

高速USB转4路RS422串口

基于480Mbps 高速USB转8路串口芯片CH344Q,可以为各类主机扩展出4个独立的串口。CH344芯片支持使用操作系统内置的CDC串口驱动,也支持使用厂商提供的VCP串口驱动程序,可支持Windows、Linux、Android、macOS等操作系统。因CDC类协议和类驱动的原…

Android 10.0 系统开启和关闭黑白模式主题功能实现

1. 概述 在10.0的rom系统开发定制化中,在系统SystemUI的下拉状态栏中,产品开发功能需求要求添加黑白模式功能开关的功能,就是打开黑白模式,系统颜色就会变成黑白颜色, 关闭黑白模式开关系统就会变成彩色模式,所以就需要了解下系统是怎么设置黑白模式和彩色模式的,然后添…

DA3 网站的第10位用户信息读取

目录 1.题目描述 2.输入描述 3.输出描述 4.题目分析 5.通过代码 1.题目描述 现有一个Nowcoder.csv文件,它记录了牛客网的部分用户数据,包含如下字段(字段与字段之间以逗号间隔): Nowcoder_ID:用户ID …

git:一、GIT介绍+安装+全局配置+基础操作

版本管理系统(SVN和Git): 集中式版本控制系统(SVN) SVN是集中式版本控制系统,版本库是集中放在中央服务器的. 工作流程如下: 1.从中央服务器远程仓库下载代码 2.修改后将代码提交到中央服务器远程仓库…

with ldid... /opt/MonkeyDev/bin/md: line 326: ldid: command not found

吐槽傻逼xcode 根据提示 执行了这个脚本/opt/MonkeyDev/bin/md 往这里面添加你brew install 安装文件的目录即可

华为云云耀云服务器L实例评测|如何保障华为云云耀云服务器L实例的安全和性能

引言 云耀云服务器L实例是华为云提供的高性能计算实例,为用户提供稳定可靠的云计算环境。为了保障实例的安全和性能,用户可以通过设置防火墙和安全组策略来限制网络访问和防止恶意攻击。华为云提供了灵活的管理工具,用户可以通过控制台、API…

关于ElementUI之首页导航与左侧菜单实现

目录 一.Mock 1.1.什么是Mock.js 1.2.特点 1.3.安装与配置 1.3.1. 安装mock.js 1.3.2.引入mock.js 1.4.mockjs使用 1.4.1.定义测试数据文件 1.4.2.mock拦截Ajax请求 1.4.3.界面代码优化 二.总线 2.1.是什么 2.2.前期准备 2.3.配置组件与路由关系 2.3.1. 配置组件 …

客户端负载均衡_负载均衡策略

以前的Ribbon有多种负载均衡策略 RandomRule - 随性而为 解释: 随机 RoundRobinRule - 按部就班 解释: 轮询 RetryRule - 卷土重来 解释: 先按照RoundRobinRule的策略获取服务,如果获取服务失败则在指定时间内会进行重试。 Weigh…

Golang import

常规 import ("fmt" ) //可以直接调用 fmt.Println("Hello World!!!")省略包名引入 import import ( . "fmt" ) //可以不写包名直接调用 Println("Hello World!!!")别名 import (f "fmt" ) //可以使用自定义名称调用 f.…

北京智和信通亮相2023IT运维大会,共话数智浪潮下自动化运维新生态

2023年9月21日,由IT运维网、《网络安全和信息化》杂志社联合主办的“2023(第十四届)IT运维大会”在北京成功举办。大会以“以数为基 智引未来”为主题,北京智和信通技术有限公司(下文简称:北京智和信通&…

flask+python快速搭建

app.py """APP 入口模块""" from traceback import format_excfrom api_limiter import limiter from flask import Flask, jsonify import loggingfrom controller import api_sql_blueapp Flask(__name__) limiter.init_app(app) app.regist…

golang:context

context作用 goroutine的退出机制 多个goroutine都是平行的被调度的,多个goroutine如何协调工作涉及通信、同步、通知和退出 通信:goroutine之间的通信同步chan通道 同步:不带缓冲的chan提供了一个天然的同步等待机制。通过WaitGroup也可以…

【学习草稿】背包问题

一、01背包问题 图解详细解析 (转载) https://blog.csdn.net/qq_37767455/article/details/99086678 :Vi表示第 i 个物品的价值,Wi表示第 i 个物品的体积,定义V(i,j):当前背包容量 j,前 i 个物…

Kubernetes组件和架构简介

目录 一.概念简介 1.含义: 2.主要功能: 3.相关概念: 二.组件和架构介绍 1.master:集群的控制平面,管理集群 2.node:集群的数据平面,为容器提供工作环境 3.kubernetes简单架构图解 一.概…

技战法-信息收集

搜索引擎语法 Google hacking: site: 限制搜索范围为某一网站,例如: site:baidu.com"admin”可以搜索baidu.com 网站上包含关键词“admin”的页面。 inurl: 限制关键字出现在网址的某个部分,例如: inurl:php?id 可以搜索网址中包含 ph…

Kafka 运维必懂:从原理到调优,看完秒变大佬

1 Kafka 概述 Kafka 起初是 由 LinkedIn 公司采用 Scala 语言开发的一个多分区、多副本且基于 ZooKeeper 协调的分布式消息系统,现已被捐献给 Apache 基金会。 目前 Kafka 已经定位为一个分布式流式处理平台,它以高吞吐、可持久化、可水平扩展、支持流…

Spring源码分析 循环依赖 三级缓存

文章目录 本文目的类图什么是循环依赖如何解决Spring三级缓存三个缓存分别放的是什么? 如果只有二级缓存代理和三级缓存二级缓存在其中的作用 源码分析创建对象之前先从缓存中查找从一二三级缓存中依次查找对象对象实例化时放入到三级缓存中何时放入一级缓存 本文目…

腾讯云cvm云硬盘扩容

过去一直记得腾讯云的系统盘扩容,关于系统盘的扩容直接点资源调整-云硬盘扩容 系统盘扩容后就可以直接使用的? 但是现在操作了发现vda 200G 但是现在vda1不能自动扩容了? 腾讯云cvm云硬盘扩容 先看一眼官方文档吧:在线扩展系统盘分区及文…

LeetCode每日一题:1993. 树上的操作(2023.9.23 C++)

目录 1993. 树上的操作 题目描述: 实现代码与解析: 模拟 dfs 原理思路: 1993. 树上的操作 题目描述: 给你一棵 n 个节点的树,编号从 0 到 n - 1 ,以父节点数组 parent 的形式给出,其中 p…