Skip to content

docs: 发版前文档与注释核对清理 - #101

Merged
CSJ608 merged 4 commits into
mainfrom
docs-release-polish
Oct 15, 2026
Merged

CSJ608 merged 4 commits into
mainfrom
docs-release-polish

Conversation

@CSJ608

@CSJ608 CSJ608 commented Oct 15, 2026

Copy link
Copy Markdown
Owner

内容

发布 2.7.0 前对全部文档与代码注释做核对后的清理(不改变任何代码行为):

事实性错误

  • Xml 包描述:csproj Description 与 DESIGN 中的「XmlSerializer / XmlWriter 编解码」修正为实际实现(XmlReader→XDocument 解码、XmlWriter 编码,从未使用 XmlSerializer)——该描述展示在 NuGet 包页
  • ConnectionMetrics:删除「netstandard2.0 为 no-op 兜底」的陈旧注释(实际经 System.Diagnostics.DiagnosticSource 包提供同款 API,与 csproj/README 一致)
  • IFrameDiscardReporting:「不实现本接口的第三方 codec」→「第三方定界器」(该接口由 framer 实现)

注释风格统一

文档更新

  • DESIGN 项目结构树补齐现有文件(Diagnostics / Compatibility / RetryDelayScheduler / 会话感知类型 / bench 与两个 samples);demo 场景数三→五
  • CHANGELOG 2.1.0 段去重(新增/变更四处重复条目;经 tag 区间核实 LOGO「随本版本生效」为正确说法,错挂的 social preview 句删除——该资产实为 2.2.1 引入);移除 2.1.0/2.2.0 空「暂无」段
  • README.en 的 JSON 最简驱动示例从「安装」移至「Codec」小节,与中文版结构对齐

验证

  • dotnet build StreamFrame.slnx -c Release:0 警告 0 错误
  • dotnet test StreamFrame.slnx -c Release --no-build:140+140+132 全绿(3 个 soak 按设计跳过)
  • grep 复查:src 内英文复述行清零

@CSJ608
CSJ608 merged commit 85dbeb1 into main Oct 15, 2026
5 checks passed
@CSJ608
CSJ608 deleted the docs-release-polish branch October 15, 2026 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant