NgDocs Provider 怎么用呢？

Question

我正在为我的团队编写框架文档，我想添加提供程序。当我添加 @ngdoc 提供商时，它对我说：

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

我看过 angular 的 ngRoute 模块，他们使用这种语法。实在看不懂...

还有一件事，在 angular 文档中他们使用 @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
     */

NgDocs Provider 怎么用呢？

NgDocs Provider How use it?

angularjs

documentation

npm