ngdoc：如何记录方法的异常和事件？

Question

我目前正在为AngularJS模块编写文档。在ngdoc中是否有合适的方法来记录由模块方法抛出的异常和事件？

UPD： 在“应用代码标准”部分中的AngularJS contributing guidelines说，ngdoc是jsdoc格式的只是一个扩展版本。这是否意味着我可以使用@fires和@throws语法来执行我所需要的操作？

Answer 1

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

@ngdoc事件

你可以把不同的信息，详细解释事件发生或当它被炒鱿鱼或东西。

而ngdoc是jsdoc的自定义版本，所以你可以使用jsdoc-Tags，但是没有特定的角度！