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

Question

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

UPD:在AngularJS贡献指南中的“应用代码标准”部分中说ngdoc只是jsdoc格式的扩展版本。这是否意味着我可以使用“火灾”和“抛出”语法来做我需要的事情？

Answer 1

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

@ngdoc事件

您可以提供不同的信息来详细解释事件是做什么的，或者什么时候被解雇什么的。

ngdoc是jsdoc的自定义版本，所以您也可以使用jsdoc标记，但是没有角特定！