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提供程序如何使用它？

回答

相關問題