问题标签 [ngdoc]

我正在使用 ngDocs 以角度记录指令。文档和示例运行良好，但没有生成演示，因为指令所基于的主模块是在生成页面后声明的。所以我得到错误：“模块'主模块'不可用！”

这是我的主要模块：

在生成示例演示之前，我必须添加什么才能使 angular 运行主模块？

我尝试使用@exports 标记导出主模块以在指令中使用，但它似乎不起作用，并且我得到了同样的错误。

想知道 ngdocs 是否有任何 JSCS 检查？

或者，您建议 AngularJS 代码使用哪种文档框架以及检查代码是否记录良好的可能性？

可能与此有关：grunt-ngdocs 的“文档覆盖率”

I would like to add ngdoc documentation to a function declaration within an angular service. How can I do this for myFunction in the example below?

I reckon I need something like @closure, @functionOf or @functionIn.

Please note that (in contrast to myMethod) myFunction is not a method.

我开始使用ngdoc（jsdoc 的变体）记录我的应用程序。我要做的第一件事是记录我的主模块。这个模块依赖于一堆角度模块，例如ngAnimate。我想指出这些要求：

http://localhost:9999/#/api/ngAnimate但是，这会在我的服务器上生成一个链接。它正确地假设我指的是文档中的其他内容。

如何表明需求来自外部来源？例如：

鉴于此代码：

我得到这个文件：

也就是说，该Foo.bar.baz属性不会出现在文档中。它被正确解析 - 因为如果我从 更改@propertyOf为zomg.Foo.bar类似zomg.Foo.doesnotexist的内容，编译文档时会出现错误。但结果不会显示在生成的 HTML 中。

我应该如何记录嵌套对象？实际用例是我有一个包含$resources 的服务，我想在$resource. 我宁愿以标准的 jsdoc 方式（@ngdoc function带有@methodOf特殊功能本身）而不是以非标准方式将其包含在 jsdoc@description中$resource。

我正在尝试为我的 Angular 项目使用 ngDoc 获得一个基本示例。

这是一个例子：

编译文档时会显示示例标题，但没有嵌入示例。

这是编译文档的链接：

http://thinkingmedia.github.io/thinkingmedia-ui/#/api/ui.components.uiRepeat

这是 Angular 文档的链接，显示了示例的外观：

https://docs.angularjs.org/api/ng/directive/ngClick

我不知道我的 ngDoc 有什么问题？

我想将我的 css 样式表添加到 ngdocs 文档中的实时演示示例中。

我希望样式影响演示本身，但显然，它们不应该影响整个网页。

我尝试将我的样式表添加到 gruntfile ngdocs 选项中，如下所示：

这确实将 mylayout.css 作为链接标记添加到 index.html 的标记中，作为 head 部分中最后包含的链接标记，但其中的样式会覆盖整个页面上的样式。不好。

我该怎么做才能使我的样式在现场演示中起作用，但在页面的其余部分不起作用？

谢谢你的帮助！希望这将对 ng-docs 上非常有限的可用信息做出贡献！

编辑：我最终做的是创建一个名为 myNgdocsLayout.css 的新 css 文件，我在其中编写了几个覆盖 mylayout.css 的样式，同时仍然允许 mylayout.css 样式应用于现场演示。

现在我的页面看起来不错，但这绝对不是一个完美的解决方案。如果有人能提出一个想法，让我的样式仅适用于我的现场演示，而无需在页面的其余部分覆盖它们，我仍然会很感激......如果没有构建我会感到惊讶- 在 ngdocs 中这样做。

您好，我正在尝试通过 grunt 和 ngdoc 为我的 ionicframework/angularjs 应用程序创建文档。

我已经在http://gruntjs.com/getting-started中安装了所有喜欢的东西

好吧，如果我现在运行 grunt

我得到：

而且我无法显示文档。

我的 gruntfile 看起来像这样：

我是为 angularjs 创建文档的新手，那么为此目的的最佳实践是什么？

我有一个名为“utils”的服务。该服务有一些方法。

此外，此服务会触发 2 个广播：“authUtilsFailed”和“authUtilsLoaded”。

我如何记录这 2 个广播？（使用 angular-jsdoc）

谢谢，

冷杉。

我是代码文档的新手，并试图用 grunt-ngdocs 记录我的角度应用程序。

我从以下位置克隆了一个工作示例：https ://github.com/m7r/grunt-ngdocs-example

给定的示例缺少文档控制器，因此我使用以下代码添加了自己的文档控制器：

当我尝试通过从命令行运行 grunt 来构建文档时，我收到以下错误消息：

我该如何解决？我阅读了本指南http://www.shristitechlabs.com/adding-automatic-documentation-for-angularjs-apps/，但我不明白为什么我尝试记录控制器时会不断收到错误消息:(谢谢寻求帮助！