【发布时间】:2014-11-23 14:15:16
【问题描述】:
在官方文档中,你经常会看到这样表示的类型:
!Array.<string>=(例如:https://docs.angularjs.org/api/ng/function/angular.module)
这是什么意思? (尤其是我的示例中的 ! 和 = 符号)?它在哪里解释?这是否是我迄今为止一直缺少的通用标准?
【问题讨论】:
标签: angularjs jsdoc code-documentation
在官方文档中,你经常会看到这样表示的类型:
!Array.<string>=(例如:https://docs.angularjs.org/api/ng/function/angular.module)
这是什么意思? (尤其是我的示例中的 ! 和 = 符号)?它在哪里解释?这是否是我迄今为止一直缺少的通用标准?
【问题讨论】:
标签: angularjs jsdoc code-documentation
引用 Angular guide on writing AngularJS Documentation
AngularJS 项目的所有文档都使用一种 jsdoc 形式。 (...) AngularJS 使用的 jsdoc 风格称为 ngdoc,并由名为 Dgeni 的 Node.js 实用程序解析。
这里:http://usejsdoc.org/tags-type.html
所以,例如这里的! 表示参数不能为null。= 表示该参数是可选的。
【讨论】: