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，但是沒有特定的角度！