问题标签 [ngdoc]

我正在使用ngdocs来记录我的 AngularJS 应用程序。我在 API 中有一个特定于指令本身的控制器。我试图将其记录为@module.directive:dirName.controller:ControllerName，但这似乎没有正确标记它，并且控制器最终被记录在标记为 的新模块下module.directive:directiveName。我应该在下面记录这个module吗？有人对最好的方法有任何想法吗？

如何使用 记录 jQuery 小部件gulp-ngdoc？我有这样的事情：

...我收到以下错误：[Error: Don't know how to format @ngdoc: widgets]

我已经执行了 gulp ngdocs 命令，并且在项目文件夹结构中创建了 docs 文件夹。当我尝试运行 index.html 时，数据没有被加载，但是当我尝试运行 partials 文件夹中存在的 js 文件之一时，数据正在加载。我错过了什么吗？请帮忙。

Docs 文件夹内的内容
css,partials,js,fonts 文件夹和 index.html

我最近决定在我的大部分与 JavaScript 相关的构建和捆绑包中使用 webpack，但有一个部分我一直无法弄清楚：如何使用 webpack 运行 ng-docs？

我知道 ng-docs 能够通过 grunt 和 gulp 通过它们各自的 ng-doc 包运行，但如果我已经在使用 webpack（特别是如果我需要只是一件小事）。

我一直在网上搜索可以通过 webpack 运行 ng-docs 的东西（我本来希望某种插件可以与加载器一起使用或其他东西来执行此操作），或者只是一个我可以包装的普通 ng-docs 包在我的 webpack 配置中使用一些 NodeJS 代码，但没有找到任何东西。是否存在这样的包，我可以通过插件和/或加载器为它使用 webpack？是否有一个包可以让我从命令行运行 ng-docs？

下面是我的 grunt ngdocs 任务。

我的 ngdoc 示例块是从 Angular 文档中复制的。我刚刚添加了“ngMaterial”作为依赖项。

以下是我得到的错误。

如果我将 'ngMaterial' 作为依赖项删除，则此示例块绝对可以正常工作。我正在使用 Angular 1.4.3 和 Angular-material 1.0.5。请帮忙。

我刚刚查看了ngDoc，尽管文档很少，但我知道它需要在@name标签中使用非常具体的命名空间语法，例如

在指令的情况下（从这里收集）。

然而，官方认可的 Angular 风格指南说我们应该用点命名我们的模块（例如app.users）。

现在，我只是不明白，还是这两件事相互排斥？！？

有没有办法逃避moduleNamefor ngDoc？我真的不觉得特别喜欢重命名我的所有模块（另外，我碰巧认为样式指南很有意义）......

虽然我可以从文件系统中grunt-ngdocs自动生成index.html，但每次我尝试查看我得到的文档中的描述时：

即使docs/partials和docs/partials/api文件夹都是空的。

这是我的grunt-ngdocs配置

我究竟做错了什么？

先感谢您

如何使用 ngdoc 记录返回“工厂函数”的“角度工厂”？具体来说，我如何记录我的“工厂函数”创建的对象？

在下面的人为示例中，我记录了如何使用工厂创建页面对象，但是我如何记录如何使用页面对象本身呢？

我可以在 SO 上找到的最接近的匹配项是：如何记录一个使用 ngdoc 以角度返回类的工厂？. 这无济于事，因为我没有使用“类”名称将方法链接回，因为我没有使用伪经典继承。

我正在编写一个 AngularJS 组件，我想知道将 ngdoc 注释添加到组件本身和控制器功能的正确方法是什么。

你有什么例子吗？

我在项目中的指令越来越大，有很多不同的选择

我的参数之一称为tableFields此对象，您可以添加很多选项：

为此，我尝试创建一个typedef（类型定义）但没有运气：

可悲的是，当我生成我的文档时，它只给了我这个：

所以我的问题是如何指定字段的要求或进行类型定义？