dotnet / dotnet/api-docs-sync

How to deal with cross assembly crefs

Đang mở
#81 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
port-to-tripleslash
Ngôn ngữ chính
C#
Star
14
Fork
21
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

I backported docs to System.IO as an experiment. It made FileSystemName (which is in corelib) have `` (which is in a different assembly). This is fine for the docs build because its context is apparently "everything". However the compiler complains with CS1574 and I have to remove the cref.

When making code the source of truth, how can we preserve cref's across assemblies?

@carlossanlop

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

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

Bắt đầu bằng cách kiểm tra cách api-docs-sync xử lý các comment ba dấu gạch chéo, IntelliSense XML và các giá trị cref trong quá trình thử nghiệm với System.IO. Tái hiện tham chiếu xuyên assembly từ FileSystemName đến System.IO.FileSystemWatcher và so sánh bản build tài liệu với chẩn đoán CS1574 của compiler. Được xem là hoàn tất khi workflow source-of-truth bảo toàn tham chiếu mà không kích hoạt lỗi compiler đó.

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

Đánh giá

Công nghệ
csharp
Lĩnh vực
documentation, tooling
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/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.