问题标签 [ngdoc]

给定一个带有返回类的工厂的 Angular 应用程序，如下所示：

使用ngdoc（jsdoc角度使用的特殊风格），我如何记录初始化程序而不将其定义为方法？

现在，这是我尝试过的：

但这会导致User初始化程序（User接受参数的函数name）被视为具有 name 的方法Initializer，这让尝试使用此代码的人感到困惑。

我试过添加@constructor标志，但这对 htmldgeni最终生成没有影响。

谢谢你。

更新：删除了对dgeni. 我的印象是我使用的插件（grunt-ngdocs）dgeni在幕后使用，但事实并非如此。

我正在尝试使用 ngdocs 和 grunt 记录我的 Angular WebApp。我想知道有没有办法记录路由配置，因为我觉得我的 WebApp 路由系统相当复杂，并且在其文档部分需要注意。

无论如何我可以在控制器，工厂等级别上拥有它吗？

我可以把它放在下面的水平：

谢谢， 安基特

我有一个包含API 文档部分和教程部分的工作文档页面。当我在面包屑导航中单击Tutorial时，内容区域中会出现一个空白页面，并且浏览器标题栏显示“core-js: Error: Page Not Found!”。对于API 文档按钮，可以观察到相同的行为。

单击主导航栏链接（或主面包屑项）时将加载什么文件？如何在 Gruntfile.js 中配置此行为？

我使用 Firefox 开发工具来监控相应文件的 ajax 请求，但是当我单击教程链接时没有看到请求。我在 Gruntfile.js 中尝试了几个选项，并尝试将 tutorial.html 文件放入我生成的文档目录中 - 没有成功。

根部分的页面上不可能有内容吗？

我将 grunt 任务配置为在单击主导航栏的项目链接core-js时打开Intro页面，我希望Tutorial链接的这种行为，但我更希望有一个特定的Tutorial页面。

我当前的 Gruntfile 代码：

如何修改grunt-ngDocs生成的网站外观模板？

最终目标是将生成的文档集成到网站中。

例如，我们希望为每个主题显示以下选项卡

• Demo（专注于最终用户渲染）
• 代码（针对开发人员）

为此，我们需要修改 ngDocs 使用的模板，但是怎么做呢？

为了生成我的项目的文档，我使用 ng-docs：

https://github.com/m7r/grunt-ngdocs

我想要一份关于哪些元素（控制器、指令等）尚未使用 grunt-ngdocs 记录的报告。

理想情况下，该报告可以直接添加到文档中，或者以某种方式轻松找到缺少文档的文件。这样的繁重任务或插件是否存在？

我有一个用 NGDOC 记录的大型 AngularJS 项目。我们有很多表格，特定的指令只能包含在特定的表格中。这现在被记录为依赖项 - 每个指令在其注释中都有 @requires my.directive:myFormContainerBlaBla。此指令的生成文档包含到依赖项部分中的 myFormContainerBlaBla 的适当链接。

但是，myFormContainerBlaBla 的文档不包含对可能在其中使用的指令的任何引用。记录指令的菜单列表也是扁平的。有没有办法做到这一点：

1) myFormContainerBlaBla 的文档包含指向所有 @require 它的指令的链接。

2) 文档化指令的菜单列表是分层排列的，即

我无法描述控制器方法。我怎么能这样做？

我正在使用 ngdoc 来自动生成文档。但我不明白我做错了什么。

我grunt-ngdocs用来记录我的 Angular 项目。但是演示 Plunker 代码（自动生成）不包含 CSS 文件。

我的配置Gruntfile.js包括：

在我的 JS src 文件中：

在 API 页面上，正确加载了 JS 和 CSS 文件。但是显示的demo源代码不包括 CSS 文件：

在我的 API 页面上，演示运行良好。但是链接到 Plunker 不会产生预期的结果，因为不存在包含行的 CSS。有什么建议么？

我正在使用 OSX 10.10、Webstorm 10.0.4、AngularJS 1.4.3

例如：

我希望当我输入var a = new BatchPlanModel()控制器时，会出现一些关于参数或文档的提示。但是当我按下 F1 时显示的是控制器的定义。喜欢：

并添加类似的东西

在var BatchPlanModel = ...没有帮助之前。

如果我这样评论我的文件，标题几乎总结了它：

我收到以下错误：

查看存储模板的文件夹时，我看不到它。我刚刚安装了 dgeni 和 degeni-packages。如有必要，我可以粘贴我的 conf 文件。我没有通过 grunt/gulp 运行，而是通过命令行运行它。