使用docular记录angular.js应用程序

时间:2014-09-02 11:04:03

标签: javascript angularjs documentation

我在记录我的应用时遇到了一些麻烦。我正在使用http://grunt-docular.com/及其标记来记录我的模块。

但是,当谈到作为服务一部分的方法时,angular.js文档本身的标记与docular建议的标记不同。

例如,在angularjs源代码中,您将找到如下文档:

  /**
   * @ngdoc method
   * @name ng.$q#defer
   * @kind function
   *
   * @description
   * Creates a `Deferred` object which represents a task which will finish in the future.
   *
   * @returns {Deferred} Returns a new instance of deferred.
   */

查看@name,您会看到deferng.$q模块的一种方法。但是当我使用带有#{1}}标签的语法时,它被解释为一个额外的模块,例如。

#

成为文档/** * @ngdoc service * @name myApp.service:myService * @description * some description */ angular.module('myApp').service('myService', function() { return { /** * @ngdoc method * @name myApp.service:myService#fetch * @description * Some description */ fetch: function(forceUpdate) { } }; }]); 。但是当像这样使用myService#fetch时,它可以工作:

@methodOf

这是为什么?这是记录我的服务的错误方式吗?为什么它在角度代码中工作?

0 个答案:

没有答案