问题标签 [compodoc]

我正在将 compodoc 用于 Angular 应用程序并使用文档覆盖率来确保我完全记录了该应用程序。当 Statement 值为 0/3 或 1/2 时，如何确定代码/文件中的 /**... 注释中缺少哪些文档？

示例 - 对于我的用户组件，我的评论是：

该文件的文档覆盖声明 (33% 1/3)。缺少的 2/3 是什么？我如何确定组件、注射剂等需要哪些文件？？？

我正在使用 Compodoc 为 Angular 应用程序生成文档，网址：https ://github.com/compodoc/compodoc

生成文档时，出现错误。那时，脚本正在访问 app-routing.module.ts 文件。

这是我的 app-routing.module.ts

运气好的话？

我开始在 Angular 9 项目中使用 compodoc + storybook。

安装了所有依赖项，Storybook 工作正常，但由于某种原因，compodoc 生成的 documentation.json 是空的，如下所示：

我正在使用的命令是：

我的 tsconfig.json 是：

有什么想法可能是错的吗？

使用以下命令安装compodoc

现在我使用以下命令运行 tsconfig.app.json 文件

我得到了获取文档的网址-> http://127.0.0.1:8080 。我可以打开这个网址。但是概述部分是 balnk。我没有得到有关模块或可注入部分的任何信息。确切的错误（精确警告）我正在使用的终端如下所示

(node:19816) V8: C:\Users\sourav\AppData\Roaming\npm\node_modules@compodoc\compodoc\node_modules\viz.js\viz.js:33 无效的 asm.js：函数定义与使用不匹配

这是一个带有 compodoc 的 Angular 项目，用于帮助文档项目。

在 compodoc >演示中，他们展示了一些带有图像的文档示例，我试图在我的项目中复制它，但无法使其工作。

我已按照此线程说明进行操作。据我了解，步骤如下：

1. 在项目的根目录下创建一个文件夹
2. -a用标志命名目录： -a screenshots<-（我读对了吗？）
3. 当npm run compodoc. 它应该复制-a screenshots到documentation/screenshots

对我来说，它不是将资产文件夹复制到documentation目录中。有谁知道如何使这项工作？Compodoc 的文档没有讨论如何包含图像。

我的文件结构的屏幕截图：

谢谢。

我有从 Compodoc 创建的文档文件夹，我添加到现有的 Angular 项目中，我需要将它托管在一个虚 URL 上，例如：compodoc.dev.example.com

我还是 Angular 的新手，我不确定在哪里可以指定在哪里托管东西。这是Angular甚至可以做的事情吗？

角度版本：11

在此处输入代码> Blockquote

npx compodoc -p tsconfig.app.json src在 angular ( )中运行 compodoc 时出现下一个错误

我该如何解决？

我正在使用 compodoc 为我的 angular 项目生成文档，但它忽略了所有 .d.ts 文件，即使我在 tsconfig.compodoc.json 中包含所有 .d.ts 文件，如下所示：

运行命令：

样本输出：

如何包含这些文件？

我对 compodoc 完全陌生，使用较新版本的 dompodoc，开箱即用支持暗模式。在检查他们的文档时，我找不到任何禁用它的选项。

目前正在使用以下命令生成文档

我正在尝试为 Angular 库创建文档。是否有适当的方法来禁用 compodoc 中的暗模式？

正如标题所说，我正在将 compodoc 与 Angular 一起使用，到目前为止它运行良好。

我的问题在于代码覆盖率的计算。有没有办法修改这个计算？如果我认为它们是不言自明的，我不想记录每个变量的含义。而且我不希望我的代码中有一百万个@ignores，因为我认为它的可读性会降低。

此外，我很想知道，是否有办法显示我所缺少的。例如， compodoc 说我的代码覆盖率很低，但是当我查看我的代码时，我不知道我还能记录什么......

我错过了什么？

`