NgDocs提供程序如何使用它？

我工作在我的团队框架的文档，我想添加提供者。当我添加@ngdoc提供商就对我说：NgDocs提供程序如何使用它？

不知道如何格式化@ngdoc：供应商

我甲肝的角度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 
});

来源

2015-02-07 fromScratch

这是一个迟到的反应，但我只是想到了自己，所以我认为别人可能会觉得这有用。

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

如果你像下面的例子那样配置它，在你生成的HTML文件中，你会看到服务名称，它包含你使用'servicename'的任何东西，以及服务名称右边的小cogs图标，包含您使用'servicenameProvider'的任何内容。

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

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

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

来源

2015-05-17 14:20:54

Ty for your reponse。我使用相同的techniq单独的服务比提供者，但thx！ Mb如果你找到另一种方式不要求，我也这样做！ Cya！ – fromScratch 2015-05-18 15:38:11

NgDocs提供程序如何使用它？

回答

相关问题