ngdoc:如何记录方法的异常和事件?

时间:2013-09-01 17:17:12

标签: events exception angularjs methods documentation

我目前正在为AngularJS模块编写文档。在ngdoc中是否有正确的方法来记录模块方法引发的异常和事件?

UPD: 在{"应用代码标准中的AngularJS contributing guidelines"据说 ngdoc 只是 jsdoc 格式的扩展版本。这是否意味着我可以使用@fires和@throws语法来完成我需要的工作?

1 个答案:

答案 0 :(得分:-1)

看看https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation。 在那里描述了一个事件被声明为

  

@ngdoc事件

您可以使用不同的信息来详细解释事件的作用或触发事件的时间。

并且ngdoc是jsdoc的自定义版本,所以你也可以使用jsdoc-Tags但是没有角度特定的!