这是我的“index.ts”文件。 它实际上在这里称为imports.ts,在此之后我将其重命名为index.ts,但同样的错误。 底部终端 output 显示我写的内容,4 次,每次都显示相同的错误: 这是我的 tsconfig.json 文件: 同样键入“typedoc --out doc ...
这是我的“index.ts”文件。 它实际上在这里称为imports.ts,在此之后我将其重命名为index.ts,但同样的错误。 底部终端 output 显示我写的内容,4 次,每次都显示相同的错误: 这是我的 tsconfig.json 文件: 同样键入“typedoc --out doc ...
我必须自动化我的 typedoc 文档,以便我可以直接将它上传到汇合页面。 我已经尝试过 Sphinx 但是 typedoc 不会生成 sphinx 所需的 RST 文件 ...
TypeDoc 不理解 TypeScript 静态块。 静态块被添加到 TypeScript 4.4。 我正在使用 TypeDoc 0.22.17,它声称支持 TypeScript 版本 4.0 到 4.7 https://typedoc.org/guides/installation/ 为了让 ...
概括 我正在尝试使用 Typedoc 为 TypeScript 项目构建文档。 不幸的是,Typedoc 在我在其中一个文件中使用的导入语句中产生了错误。 我很困惑,因为我的项目中没有使用它进行错误检查的文件,或者构造我的导入类型所必需的。 问题前言 我正在导入一个类型,使用语法import t ...
我有一个 JS 项目,我在一个单独的目录中手动定义类型声明文件。 以前我使用的是 typedoc v0.19.2,它使用这个 typedoc 配置生成了精美的文档: 我的类型声明文件主要将类型信息添加到全局 scope 中,例如: 我现在正在使用 typedoc v0.20.11,它似乎没有注意到 ...
我试过这个答案。 TypeDoc 不会为本地文件生成文档。 我使用了命令: yarn typedoc ,我有 tsconfig.json,这是其中的一部分 --entryPointStrategy 对任何值都不起作用。 ...
typedoc 命令: typedoc --out./documentation/ src/ 它生成带有 HTML 的文件夹,取自 README.md,但在那里找不到我的界面的痕迹...... ...
我正在测试一些不同的文档引擎,我想为我们的大型项目尝试 typedoc。 我们在整个项目中有各种测试文件( somefile.test.ts或someotherfile.test.tsx )。 我正在努力让 typedoc 忽略这些文件。 我做了npm i -D typedoc ,然后在我的 tsc ...
我正在尝试将 TSDoc 标准用于评论用 Typescript 编写的 React 项目(着眼于使用 Typedoc 生成文档),但找不到任何明确的答案来注释 React props object 的首选方法。 到目前为止,我已经有了这个,其中MyProps是一个接口:/** * Descrip ...
代码是: 我在TSDoc 操场上查看它,看到有 class 的摘要,但没有其领域的摘要有没有办法在 typedoc 中描述一个字段? ...
我安装了typedoc: 然后将 typedocOptions 添加到 tsconfig.json 中: 然后我做: 并得到错误: 我该如何解决? ...
如何在 typescript 中记录联合类型,以便typedoc可以提取/显示相关信息? 下面是一份 JSDoc 参考资料,但是否有 TSDoc 参考资料? 例子/** * Search parameters * These comments are not picked up, I gene ...
我刚刚开始将 TSDoc 与 TypeDoc 结合使用,我喜欢它。 我有一个小问题,嗯,真的很烦。 我希望eslint-plugin-tsdoc忽略将用于生成 api 文档的文件,我将使用apidocjs.com为我生成该文档。 在PhpStorm和command line中,我收到这些文件的警告, ...
我可以使用https://github.com/TypeStrong/typedoc来创建 REST API 文档,例如https://apidocjs.com/吗? 欢迎任何关于如何重用 TypeScript 类型生成 REST API 文档的建议(使用 Next.js) ...
我在我的一个项目中使用 Deno,我想用 typedoc 生成文档。 我面临着很多依赖关系的问题,因为它们没有得到正确解决,所以 typedoc 失败了。 我有以下tsconfig.json : paths的前两个条目解析 Deno 的本机模块(如其断言库)。 当我使用像deps.ts这样的另 ...
我使用“deno doc --Json > sample.json”为我的 Deno 项目中的特定模块创建了 JSON 格式文件。 这将创建模块的 sample.json 文件。 然后我在本地克隆并设置了 doc_website。 但我很困惑如何在 doc_website 中使用 sample ...
我听说 Deno 有一个内置的文档生成器,它使用我想在我的包上运行的命令deno doc 。 但事实证明它只生成 JSON 文档,并且必须使用另一个工具来生成 HTML 文档。 是否有任何现有工具可用于生成本地 HTML 文件? 这些是专有软件包,不能 go 到官方 deno doc 网站上。 我 ...
我是 TypeScript 的新手,我有一些现有的 TypeScript 项目。 为了更好地理解项目,我尝试使用 TypeDoc。 但是,我收到以下错误。 我试图在类似的问题之后解决这个问题,但没有奏效。 谁能告诉我解决这个问题的方法是什么? package.json 。 ...
我已经记录了一个function并且我可以看到生成器已经捕获了行号: 是否可以配置 TypeDoc 以便用户可以点击查看实际的源代码? 完整的存储库在这里。 ...
我正在使用TypeDoc来记录我的 TypeScript 代码,就像这样:/** * @param timestampValue Date in timestamp format */ const getDaysInTimestamp = (timestampValue: number): nu ...