NgDocs提供者如何使用它？

Question

我为我的团队中的一个框架编写文档，我想添加提供者。当我添加@ngdoc提供者时，它对我说：

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

我看过角的ngRoute模块，他们使用这个语法。我真的不明白..。

此外，关于角文档，他们使用@ngdoc模块，我需要使用object。我想我使用了错误的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

这是一个迟来的反应，但我只是自己想出来，所以我想别人可能会发现这是有用的。

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

如果您像下面的示例一样在生成的HTML文件中配置它，您将看到包含与'servicename‘一起使用的内容的服务名称，以及服务名称的小齿轮图标，以及包含与'servicenameProvider’一起使用的所有内容的服务名称。

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

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

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