microsoft / microsoft/TypeScript

@description JSDoc tag interferes with callback parameter documentation

Đang mở
#37,346 0 bình luận 0 reaction 1 người được giao Xem trên GitHub

@orta đang làm issue này rồi.

Từ ngày 2/9/2020.

Bug checkJs Domain: JSDoc Help Wanted
Ngôn ngữ chính
Go
Star
111k
Fork
14.3k
Merge trung bình
2 ngày 4 giờ
Pull request đã merge (30 ngày)
132

Mô tả

TypeScript Version: 3.8.3

Search Terms: jsdoc param

Expected behavior:
Below code creates no errors, type of x is recognized as (value: number) => boolean

Actual behavior:
Type of x is () => boolean, the invocation creates a type error.

Removing the @description tag makes the code work as expected.

My interpretation of https://jsdoc.app/tags-description.html is that you should be able to place @description anywhere in the comment without interfering with other tags:

By using the @description tag, you can place the description anywhere in the JSDoc comment.

Related Issues: Ran into a crash #37265 while trying to repro this with template parameters.

Code

// @ts-check

/**
 * @callback IterablePredicate
 * @description return true if given element of iterable matches an internal condition
 * @param {number} value the current item being evaluated
 * @returns {boolean} true if the entry satisfies given condition
 **/

/**
 * @type {IterablePredicate}
 */
let x;
x(3) // Expected 0 arguments, but got 1.
Compiler Options
{
  "compilerOptions": {
    "noImplicitAny": true,
    "strictFunctionTypes": true,
    "strictPropertyInitialization": true,
    "strictBindCallApply": true,
    "noImplicitThis": true,
    "noImplicitReturns": true,
    "alwaysStrict": true,
    "esModuleInterop": true,
    "checkJs": true,
    "allowJs": true,
    "declaration": true,
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    "moduleResolution": 2,
    "target": "ES2017",
    "jsx": "React",
    "module": "ESNext"
  }
}

Playground Link: Provided

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.