问题标签 [compodoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
0 回答
685 浏览

angular - 由于内存问题,compodoc 未生成图形

运行命令 'npm run compodoc' 并看到这个问题:

生成图形时出错::中止(“无法扩大内存数组。(1)使用 -s TOTAL_MEMORY=X 编译,X 高于当前值 16777216,(2)使用 -s ALLOW_MEMORY_GROWTH=1 编译,这允许在运行时但会阻止一些优化,(3) 在程序运行之前将 Module.TOTAL_MEMORY 设置为更高的值,或者 (4) 如果您希望 malloc 返回 NULL (0) 而不是此中止,请使用 -s ABORTING_MALLOC=0 "进行编译) . 使用 -s ASSERTIONS=1 构建以获取更多信息。

有人知道如何在这里正确增加内存大小以使其工作吗?现在,它生成组件的文档,但不生成路由的文档(猜想这与图形生成的内存问题有关)

0 投票
0 回答
66 浏览

angular - 如何获取像 Compodoc 这样的 Angular 路由信息?(在编译时)

谁能指导我如何收集有关 Angular 中的路线的信息,例如 Compodoc?(在编译时)

他们如何在 Angular Compodoc 中获取信息?

为此目的是否存在任何特定功能?

一些信息,例如:

  • 路线名称
  • 路线之间的关系
  • 相关组件
  • 等等

你可以在这里找到链接

在此处输入图像描述

0 投票
1 回答
1406 浏览

angular - 如何自定义 Compodoc Angular 文档?

我尝试使用现有的 compodoc 文档添加额外的侧导航菜单。

我可以像下面那样做。

菜单-wc.js

当我们使用这个 npm 命令更新我们的文档时

变化消失了。每次执行此命令时新创建的 main-wc.js 文件。

有什么方法可以自定义 compodoc 文档吗?

在此处输入图像描述

0 投票
0 回答
232 浏览

angular - 如何从compodoc生成的json文件中删除源代码

我刚刚找到了 compodoc,一个用于 Angular 项目的文档工具。它可以工作并且可以创建一个包含项目所有信息的 json 文件。但是我想摆脱文件中的所有源代码信息,我需要这样做以进一步处理数据库中的信息。

我在github上下载了compodoc的源代码,并修改并构建了它。它在构建后给了我一个 index.js 和 index-cli.js 文件。但我不知道如何处理这些文件。

有人知道如何使用它们或知道如何从 json 文件中删除源代码吗?

谢谢。

0 投票
1 回答
576 浏览

angular - 在 GitLab 上部署 Compodoc 文档而不使用 GitLab Pages

亲爱的开发者,

我想将我们的Compodoc文档部署到GitLab,以便我们团队中的每个开发人员都可以使用它(如 API 页面)。

根据我工作的公司的说法,我不能GitLab为此使用 Pages。

有任何想法吗?

任何帮助表示赞赏

0 投票
1 回答
132 浏览

angular - 我无法在 compodoc 的示例部分插入引号

我正在用“compodoc”记录我的项目,我喜欢这个工具,但是当我尝试插入报价时,我得到一个错误的视觉效果。

我有这个评论

我期待这个

但实际输出是

0 投票
1 回答
1199 浏览

angular - 如何使用 Compodoc 生成文档文件(pdf 或 doc)?

我正在使用 Compodoc 来记录我的 Angular 应用程序

如何使用 Compodoc 生成文档文件(pdf 或 doc)

0 投票
1 回答
887 浏览

angular - 如何在 compodoc + angular2 中正确记录界面属性

我已经开始使用 compodoc 来记录我的应用程序,并且在评论记录 openWeather api 接口时我正在努力获得干净的代码。

我已经尝试过常见的@propertyJSDoc 标记,但它不适用于 compodoc,因此要使其按预期工作,我需要编写类似这样的内容

我只想在代码的开头而不是在每个属性上方有评论,就像旧的 JSDoc@property {type} [name] 甚至可能有下面这样的东西?或者也许比上面更清洁的方式?

我这边的小编辑

评论不需要换行,你可以将所有内容都放在一个单行/** */中,如下所示:

0 投票
1 回答
168 浏览

angular - Compodoc 可以离线安装吗?

我需要以某种方式下载 Compodoc 的文件并将其移动到另一个无法访问 Internet 的系统。

如何下载 Compodoc 实用程序并将其安装到离线系统?

我在他们的网站上没有看到任何与离线安装有关的信息。 https://compodoc.app/guides/installation.html

该工具为 Angular CLI 项目生成文档,我们的项目确实需要记录。

0 投票
1 回答
956 浏览

angular - 无法在文档覆盖范围中排除目录 [compodoc]

我使用 compodoc 生成文档,我想从文档覆盖范围中排除一些文件/目录

我添加了 tsconfig.json 文件的 exclude 属性。

这些文件很好地从文档中排除,但不在文档覆盖范围内。

请问有人有什么想法吗?