我目前正在为 AngularJS 模块编写文档。ngdoc 中是否有适当的方法来记录模块方法引发的异常和事件?
UPD: 在“应用代码标准”部分的AngularJS 贡献指南中,据说ngdoc只是jsdoc格式的扩展版本。这是否意味着我可以使用@fires 和@throws 语法来做我需要的事情?
我目前正在为 AngularJS 模块编写文档。ngdoc 中是否有适当的方法来记录模块方法引发的异常和事件?
UPD: 在“应用代码标准”部分的AngularJS 贡献指南中,据说ngdoc只是jsdoc格式的扩展版本。这是否意味着我可以使用@fires 和@throws 语法来做我需要的事情?
看看https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation。那里描述了一个事件被声明为
@ngdoc 事件
您可以放置不同的信息来详细解释事件的作用或触发时间等。
ngdoc 是 jsdoc 的定制版本,因此您也可以使用 jsdoc-Tags,但没有特定于角度的!