NgDocs Provider 怎么用呢？答案

【问题标题】：NgDocs Provider How use it?NgDocs Provider 怎么用呢？
【发布时间】：2015-04-07 17:45:09
【问题描述】：

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

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

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

还有一件事，在他们使用@ngdoc 模块的角度文档中，我需要使用对象来代替。我想我使用了错误的 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
});

【问题讨论】：

标签： angularjs documentation npm

【解决方案1】：

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

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

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

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

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

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

【讨论】：

欢迎您的回复。我将相同的技术用于单独的服务而不是提供者，但是谢谢！ Mb，如果您找到另一种方式，请不要犹豫，我也会这样做！赛亚！