Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Creating .d.ts Files from .js files : Half-broken link to "the reference here" (JSDoc)

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

Maintainer thường phản hồi trong vòng 1 ngày

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

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
55/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với trang Creating .d.ts Files from .js files được liên kết và kiểm tra phần giới thiệu của trang này cùng với các trang JSDoc được liên kết trong TypeScript Handbook. Xác minh anchor supported-jsdoc bị hỏng và cập nhật tham chiếu để nó dẫn đến tài liệu JSDoc dự kiến; hoàn tất khi liên kết trỏ đến phần tham chiếu phù hợp và trang được render mà không có anchor bị hỏng.

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

Mô tả

The Creating .d.ts Files from .js files page's introduction reads:

With TypeScript 3.7, TypeScript added support for generating .d.ts files from JavaScript using JSDoc syntax.

This set up means you can own the editor experience of TypeScript-powered editors without porting your project to TypeScript, or having to maintain .d.ts files in your codebase. TypeScript supports most JSDoc tags, you can find the reference here.

The second link's target anchor does not exist anymore, so the link is confusing. The target page now contains the in-jsdoc-references anchor, but looking at the page quickly, it seems like what the link should really point to is the JSDoc Reference page.

By the way
  • The page title's capitalization is inconsistent.
  • TypeScript 3.7 was released in November 2019. The page shouldn't start with that detail, and for sure it shouldn't rely on the 3.7 release notes to document JSDoc support.
Ngôn ngữ chính
TypeScript
Star
2.6k
Fork
1.5k
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
7

Chuẩn bị môi trường

Chúng tôi chưa kiểm tra các tệp thiết lập môi trường của dự án này. Hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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.

Issue khác của microsoft/TypeScript-Website

Tất cả issue của microsoft/TypeScript-Website

Issue tương tự

Thêm issue về TypeScript

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.