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

Need a way to document module namespace objects

Đang mở
  • Có gì không ổn?
#447 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ó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Khá 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 bằng cách so sánh các ví dụ về đối tượng namespace trong functions/foo.ts, functions/index.ts và Functions.ts, sau đó xem xét cách API-Extractor và TSDoc hiện gắn các chú thích vào các mô-đun entry point. Được xem là hoàn tất khi mô hình cung cấp một cách được ghi lại trong tài liệu để gắn chú thích vào đối tượng namespace của mô-đun Functions được re-export.

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

Mô tả

Problem

API-Extractor and TSDoc support adding a documentation comment to the entry point module, but not to individual re-exported modules. Modern bundlers and other tooling vastly prefer module namespace objects over static classes because they can be fully statically analyzed and tree-shaken. However, the current model does not provide a way to apply a documentation comment to an individual module that gets applied to the module namespace object (the result of import * as ... or export * as ... expressions).

functions/foo.ts
export function foo();
functions/index.ts
export { foo } from './foo';
Functions.ts
import * as Functions from './functions/index';
// How do I put a comment on this export?
export { Functions };
Ngôn ngữ chính
TypeScript
Star
5k
Fork
162
Merge trung bình
17 giờ 4 phút
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/tsdoc

Tất cả issue của microsoft/tsdoc

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.