NgDocs Provider Jak z niego korzystać?

Question

Pracuję nad dokumentacją dla architektury mojego zespołu i chcę dodać dostawcę. kiedy dodać dostawcę @ngdoc to powiedzieć do mnie:

nie wiem jak formatować @ngdoc: dostawca

ja hav patrzeć na module ngRoute z kanciasty i używają tej składni. Naprawdę nie rozumiem ...

I jeszcze jedno, na kanciastej dokumentacji używają modułu @ngdoc, potrzebuję użyć obiektu zamiast tego. Myślę, że używam niewłaściwego modułu ngdoc npm, ale jest to ostatnia wersja, którą znalazłem ...

Dziękuję, jeśli możesz mi pomóc!

PS: Używam modułu npm, -Ngdocs, jeśli chcesz, aby moje opcje zadań zadawały mi pytania.

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

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

Answer 1

To jest późna odpowiedź, ale sam to wymyśliłem, więc pomyślałem, że ktoś inny może uznać to za przydatne.

Skonfigurowałem dwa bloki JSDoc w moim pliku service.js. Jedna została wykorzystana do faktycznych metod świadczenia usług, a druga została wykorzystana przez usługodawcę.

Jeśli skonfigurujesz go tak, jak w przykładzie poniżej, w wygenerowanym pliku HTML zobaczysz nazwę usługi, która będzie zawierała wszystko, co użyłeś z "servicename", i małą ikonę zębów po prawej stronie nazwy usługi, i to będzie zawierają wszystko, co użyłeś w 'servicenameProvider'.

Myślę, że wyjaśniłem, że to trochę nieporządne, ale mam nadzieję, że masz rację.

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

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