How to deal with cross assembly crefs
未关闭
port-to-tripleslash
- 主要语言
- C#
- 星标
- 14
- 派生
- 21
- PR 合并指标
- 30 天内没有已合并 PR
描述
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
贡献指南
这个仓库没有索引到贡献指南
调研方向
首先检查 api-docs-sync 在 System.IO 实验期间如何处理三斜杠注释、IntelliSense XML 和 cref 值。复现从 FileSystemName 到 System.IO.FileSystemWatcher 的跨程序集引用,并将文档构建与编译器的 CS1574 诊断进行比较。当 source-of-truth 工作流在不触发该编译器错误的情况下保留该引用时,即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- csharp
- 领域
- documentation, tooling
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100