microsoft / microsoft/TypeScript

Handle JSDoc @param with hyphen

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

Chưa có ai nhận issue này.

Domain: JSDoc Experience Enhancement Suggestion VS Code Tracked
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: 2.7.0-dev.20171214

Code

/**
 * @param x - Bla
 */
function foo(x) { }

Hover over x

Expected behavior:
Hyphen is ignored in any documentation returned. See JSDoc @param spec: http://usejsdoc.org/tags-param.html

Actual behavior:
Hyphen is returned as part of documentation:

[Trace  - 2:58:07 PM] Response received: quickinfo (144). Request took 3 ms. Success: true 
Result: {
    "kind": "parameter",
    "kindModifiers": "",
    "start": {
        "line": 4,
        "offset": 14
    },
    "end": {
        "line": 4,
        "offset": 15
    },
    "displayString": "(parameter) x: any",
    "documentation": "- Bla",
    "tags": []
}

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.

Hướng nghiên cứu

Bắt đầu từ cách xử lý TypeScript JSDoc @param được sử dụng bởi phản hồi quickinfo hover hiển thị trong issue. Tái hiện mẫu, lần theo nơi chuỗi tài liệu được hình thành và xác minh rằng tài liệu được trả về bỏ qua dấu gạch nối phân cách nhưng vẫn giữ lại phần mô tả.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
typescript
Lĩnh vực
tooling
Loại issue
Lỗi
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

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.