Skip to content

JSDoc description for ES6 class properties does not show up in intellisense #14879

Closed
@abecks

Description

@abecks

TypeScript Version: 2.2.1

This is a JS only project.

Code

/**
 * Test class description.
 *
 * @export
 * @class Tester
 */
export class Tester {
  /**
   * Creates an instance of Tester.
   * @param {any} [params]
   */
  constructor (params) {
    /**
     * Test description 1
     * @type {String}
     * @description test description 2
     */
    this.name = params.name
  }

  /**
   * Test method description
   * @memberOf Tester
   */
  testMethod () {

  }
}

// Then open intellisense for an instance of Tester
const test = new Tester()
test.

Expected behavior:
Show the description, like testMethod:
screen shot 2017-03-27 at 11 30 30 am

Should show "Test description 1" or "test description 2"

Actual behavior:
No description is shown for the property name:
screen shot 2017-03-27 at 11 30 24 am

Metadata

Metadata

Assignees

No one assigned

    Labels

    BugA bug in TypeScriptFixedA PR has been merged for this issue

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions