dotnet / dotnet/api-docs-sync

Lists should be rendered with <item>

未关闭
#61 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
port-to-tripleslash
主要语言
C#
星标
14
派生
21
PR 合并指标
30 天内没有已合并 PR

描述

As suggested here: https://github.com/dotnet/runtime/pull/46716#discussion_r585230663

Lists should be rendered with ``

Example: https://github.com/dotnet/roslyn/blob/b09625add4da1b872e8033d2775ea514786d86e1/src/Features/Core/Portable/DocumentationComments/AbstractDocumentationCommentFormattingService.cs#L43-L56

贡献指南

这个仓库没有索引到贡献指南

调研方向

阅读 dotnet/runtime PR 46716 中的讨论,并对比 AbstractDocumentationCommentFormattingService.cs 第 43-56 行的 Roslyn 示例。在 api-docs-sync 中定位列表渲染路径,并验证其输出使用 ;当列表文档与所引用的示例一致地完成渲染时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
csharp
领域
documentation
Issue 类型
功能
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
42/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。