NgDocs提供商如何使用它？

Question

我在我的团队的框架文档上工作,我想添加提供程序.当我添加@ngdoc提供者时,它对我说:

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

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

Answer 1

这是一个迟到的回复，但我自己刚刚弄清楚，所以我想其他人可能会发现这很有用。

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

如果您按照下面的示例进行配置，则在生成的 HTML 文件中，您将看到服务名称将包含您与“servicename”一起使用的任何内容，以及服务名称右侧的小齿轮图标，其中将包含您使用的任何内容与“servicenameProvider”。

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

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

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