angularjs - NgDocs Provider 怎么用呢？

Question

我在我的团队中为一个框架编写文档，我想添加提供者。
当我添加@ngdoc 提供程序时，它对我说:

不知道如何格式化 @ngdoc: provider

我查看了 ngRoute 的 Angular 模块，他们使用这种语法。我真的不明白...

还有一件事，在他们使用@ngdoc 模块的 Angular 文档中，我需要使用对象来代替。我想我使用了错误的 ngdoc npm 模块，但它是我找到的最后一个版本......

如果你能帮助我，谢谢!

PS:我使用 npm 模块 grunt-ngdocs，如果你想要我的任务选项问我。

/**
* @ngdoc object // module ?
* @name App
*/
"use strict";
angular.module('App', [])

/**
* @ngdoc provider
* @name App.provider:AppConfigProvider
*/
.provider('AppConfig', function ()
{
   //Some stuff
});

Answer 1

这是一个迟到的回应，但我自己才弄清楚，所以我认为其他人可能会觉得这很有用。

我在 service.js 文件中配置了两个 JSDoc block 。一个用于实际的服务方法，另一个用于提供程序。

如果您像下面的示例一样配置它，在您生成的 HTML 文件中，您将看到服务名称将包含您在“服务名称”中使用的任何内容，以及服务名称右侧的小齿轮图标，它将包含您使用的任何内容与“服务名称提供者”。

我想我解释得有点乱，但我希望你明白了。

    /**
     * @ngdoc service
     * @module app
     * @name servicename
     * @description
     * Service description
     */

    /**
     * @ngdoc service
     * @module app
     * @name servicenameProvider
     * @description
     * Service description
     */