Angular官方参考文档使用哪些类型定义?

时间:2014-09-29 08:33:22

标签: angularjs jsdoc code-documentation

在官方文档中,您经常会看到如下所示的类型:

!Array.<string>=(例如:https://docs.angularjs.org/api/ng/function/angular.module

这是什么意思? (特别是我的例子中的!和=符号)?在哪里解释?这是一个常见的标准,直到现在我还不知道?

1 个答案:

答案 0 :(得分:0)

关于AngularJS文档

引用Angular guide on writing AngularJS Documentation

  

AngularJS项目的所有文档都使用 jsdoc 形式。   (......)   AngularJS使用的jsdoc的味道称为 ngdoc ,并由名为Dgeni的Node.js实用程序解析。

类型注释在哪里解释?

此处:http://usejsdoc.org/tags-type.html

所以,例如此处的!表示参数不能为null =表示此参数是可选的。