microsoft / microsoft/TypeScript
Inline JSDoc tags don't work in comments that start with plain text
Chưa có ai nhận issue này.
- 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ả
TS mostly supports inline tags, even though they're not standard, but the implementation is quirky since it's best-effort, not really a committed feature. Specifically, an inline tag works if the line starts with a non-inline tag, or is a line following such a line:
/** @param foo @see foo.bar */
or
/** @param foo - a long description
* also @see foo.bar */
This is all down to the state machine we use for parsing, so it could be improved to also support
/** for more info @see foo.bar */
Based on discussion in #5802
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách lần theo máy trạng thái phân tích JSDoc được mô tả trong issue và so sánh cách xử lý các dòng bắt đầu bằng văn bản thuần túy với các dòng bắt đầu bằng các tag không inline. Được xem là hoàn tất khi các tag inline như @see được nhận diện trong ví dụ văn bản thuần túy và các ví dụ hiện có vẫn tiếp tục hoạt động; payload không nêu tên tệp hoặc bài kiểm thử cụ thể nào.
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
- compilers
- Loại issue
- Lỗi
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 38/100