【问题标题】:Angular parameter types on jsdocjsdoc上的角度参数类型
【发布时间】:2015-08-12 22:22:18
【问题描述】:
我想知道 jsdoc 中角度指定内容的“正确”参数类型是什么?
例如。如果我有类似的东西:
/**
* Some comment
*
* @param {WhatHere} $http
* @param {WhatHere} $timeout
*/
function FooBar($http, $timeout) {
}
$http 和 $timeout 的正确类型是什么,以便 IDE(Web/PhpStorm)可以自动完成这些?
【问题讨论】:
标签:
angularjs
ide
phpstorm
webstorm
jsdoc
【解决方案1】:
Jetbrains 产品无法通过分析代码来做到这一点,Angular 的依赖注入系统有太多的魔力。但是,您可以通过至少在 Webstorm 和 PyCharm(可能还有 PHPStorm 和其他 Jetbrains 产品)中安装类型库来做到这一点:
- 转到
Preferences > Languages & Frameworks > JavaScript > Libraries
- 点击
Download…按钮
- 在左上角的下拉菜单中选择
Typescript community stubs(别担心,它也适用于 JavaScript)
- 找到 angular.js 并点击
Download and Install 按钮
- 单击
Manage Scopes… 按钮并通过单击第二列并选择angular.js-DefinitelyTyped 将angular.js 添加到您的项目中。
现在您可以像这样注释您的代码:
/**
* @param {$http} $http
* @param {$timeout} $timeout
*/
function FooBar($http, $timeout) {
}
请注意,此技巧适用于所有提供 TypeScript 社区存根的流行库!