Nhà cung cấp NgDocs Sử dụng nó như thế nào?

Question

Tôi làm việc trên một tài liệu cho một khuôn khổ trong nhóm của tôi và tôi muốn thêm nhà cung cấp. Khi tôi thêm nhà cung cấp @ngdoc nó nói với tôi:

Không biết làm thế nào để định dạng @ngdoc: nhà cung cấp

tôi hav nhìn vào ngRoute mô-đun của góc và họ sử dụng cú pháp này. Tôi thực sự không hiểu ...

Và một điều nữa, về tài liệu góc sử dụng mô-đun @ngdoc, tôi cần sử dụng đối tượng thay thế. Tôi nghĩ rằng tôi sử dụng mô-đun ngdoc npm sai nhưng phiên bản cuối cùng của nó tôi tìm thấy ...

Cảm ơn bạn nếu bạn có thể giúp tôi!

PS: Tôi sử dụng npm module grunt-ngdocs, nếu bạn muốn tùy chọn công việc của tôi hỏi tôi.

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

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

Answer 1

Đây là câu trả lời muộn, nhưng tôi đã tự tìm ra để tôi nghĩ người khác có thể thấy điều này hữu ích.

Tôi đã định cấu hình hai khối JSDoc trong tệp service.js của mình. Một được sử dụng cho các phương thức dịch vụ thực tế, và phương thức kia được sử dụng cho nhà cung cấp.

Nếu bạn định cấu hình nó như ví dụ bên dưới, trong tệp HTML được tạo, bạn sẽ thấy tên dịch vụ chứa bất kỳ thứ gì bạn sử dụng với 'tên servic' và biểu tượng bánh răng nhỏ bên phải tên dịch vụ chứa bất cứ điều gì bạn đã sử dụng với 'servicenameProvider'.

Tôi nghĩ rằng tôi đã giải thích một chút lộn xộn, nhưng tôi hy vọng bạn có điểm.

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

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