jsdoc上的角度参数类型

时间:2015-05-29 22:21:17

标签: angularjs ide phpstorm webstorm jsdoc

我想知道jsdoc中角度指定内容的“正确”参数类型是什么?

EG。如果我有类似的东西:

/**
 * Some comment
 *
 * @param {WhatHere} $http
 * @param {WhatHere} $timeout
 */
function FooBar($http, $timeout) {
}

那些$ http和$ timeout的正确类型是什么,以便IDE(Web / PhpStorm)可以自动完成这些?

2 个答案:

答案 0 :(得分:5)

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) {
}

$http $timeout

请注意,此技巧适用于所有具有TypeScript社区存根的流行库!

答案 1 :(得分:0)

我将补充Blaise的答案,因为lib名称已更改,现在是:angularjs-DefinitelyTyped。另外,请查看angularjs-DefinitelyTyped doc以了解要指定的类型,例如:

http://joxi.ru/8ZrJ9wDtzMypAj?d=1