我在我的团队的框架文档上工作,我想添加提供程序.
当我添加@ngdoc提供者时,它对我说：
当我添加@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
});
解决方法
这是一个迟到的回应,但我只是想出了自己,所以我认为其他人可能会觉得这很有用.
我在service.js文件中配置了两个JSDoc块.一个用于实际的服务方法,另一个用于提供者.
如果您像下面的示例一样配置它,在生成的HTML文件中,您将看到服务名称,其中包含您使用’servicename’的任何内容,以及服务名称右侧的小齿轮图标,并且包含您使用的任何内容与’servicenameProvider’.
我想我已经解释得有点凌乱,但我希望你明白这一点.
/**
* @ngdoc service
* @module app
* @name servicename
* @description
* Service description
*/
/**
* @ngdoc service
* @module app
* @name servicenameProvider
* @description
* Service description
*/
