问题标签 [ngdoc]

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 投票
1 回答
92 浏览

angular-routing - 如何让 dgeni/ngdoc 为 ngrouter 生成 hash-bang 链接?

我在非 html5 模式下使用 ng-router 创建文档。所有链接都应转换为 href="#!/path"。默认情况下,标签 {@link} 创建 href="path"。

这个行为是可配置的吗?

0 投票
0 回答
229 浏览

angularjs - ngDoc @param {type} - 文档输出中不呈现该类型

我正在使用 dgeni 来记录我的 angular 1.5.x 项目,无论我在哪里使用 @param {type} name description该类型都不会在输出上呈现。我已按照本教程
中的 dgeni 安装步骤进行操作。请让我知道我在这里缺少什么。

0 投票
1 回答
128 浏览

angularjs - 使用 generator-ngdoc 生成 gulp-angular 文档

我很难为我的基于gulp-angular 的项目生成文档:我正在使用这个生成器在我的项目中生成一个 docs 文件夹:generator-ngdoc(基于 dgeni)。每当我打开组件的文档时,都会收到此错误。

其中modules.js 有以下代码:

我不确定,但似乎 dgeni 在模块声明本身之前包含了模块配置。有什么解决方案吗?

0 投票
0 回答
122 浏览

javascript - ESLint 不适用于 ngDoc 名称 - AngularJS

我正在使用 ngDoc(dgeni) 为 AngularJS 应用程序创建文档,文档生成正确,但 ESLint 显示JSDoc syntax error valid-jsdoc,当然我不想禁用此规则,因为当有一些带有参数的函数没有文档时,它真的很有帮助,但是当文档正确时,ESLint 检测到名称不正确时:,例如:

但是当我删除“:”示例时没有错误:

但当然,这不是有效的 ngDoc,并且在我生成 de HTML doc 时没有正确使用。

有没有办法解决这个问题?

0 投票
1 回答
212 浏览

javascript - 为指令定义参数类型

如何在angularjs中定义指令的参数类型?使用什么类型进行&绑定?

请参阅示例代码中的 ngdoc 或 jsdoc。

UPD:我的目标是获得以下问题的答案