搜索词

• JSDoc
• @method
• @property
• 支持

建议

现在注解功能即将推出，很希望能为 @method 和 @property (也许还有 @memberof)添加支持。
我发现了一个 bug ,它只讨论了 #15715 支持，但我认为将它们放在一起看会更有意义，因为它们应该有非常常见的实现方式，而且它们满足整体的目标。至少我认为是这样，我在下面解释了我的理由！

用例

我现在有一些函数，它们可以在类上添加方法和/或获取器，等待 JS/TS 的注解功能。但是假设：当注解功能出现时，这两个标志支持总是需要的(或者至少我认为是这样：我不知道如何在没有这些的情况下让 IntelliSense 工作)!

/**
* Some class
* @class
*/
class Test {
  /* whatever */
}

// this adds a #foo() method on the class prototype as well as a #bar getter(/setter)
someMethodAddingABehavior(Test, ...params);

明天有了注解：

/**
* Some class
* @class
*/
@someAnnotationAddingABehavior(...params)
class Test {
  /* whatever */
}

示例

我希望能够像这样记录它们：

/**
* What foo is doing is great!
* @method foo
* @param {string} testParam some testing parameter
* @returns {string} some random string
* @memberof Test.prototype
*/
/**
* Bar is awesome too!
* @property {number} bar
* @memberof Test.prototype
*/
someMethodAddingABehavior(Test, ...params);

或者至少能够在类本身中记录它们：

/**
* Some class
* @class
*/
class Test {
  /* whatever */

  /**
* What foo is doing is great!
* @method foo
* @param {string} testParam some testing parameter
* @returns {string} some random string
*/
  /**
* Bar is awesome too!
* @property {number} bar
*/
}

有了这些支持，我希望在完成类型为 Test 的值的属性时，vscode 能够建议给我 foo 方法和 bar 属性。

检查清单

我的建议符合以下准则：

• 这不会对现有的 TypeScript/JavaScript 代码造成破坏性的更改
• 这不会改变现有 JavaScript 代码的运行时行为
• 这可以在不根据表达式的类型生成不同的 JS 的情况下实现
• 这不是一个运行时特性(例如库功能、JavaScript 输出的非 ECMAScript 语法等)
• 这个特性将与 TypeScript's Design Goals 的其他部分保持一致。