Some markdown-formatted remarks are ported into triple slash comments with invalid structure
- 主要语言
- C#
- 星标
- 14
- 派生
- 21
- PR 合并指标
- 30 天内没有已合并 PR
描述
As seen in `MemoryManager` from `System.Memory` in `dotnet/runtime`, some `` sections are getting produced with invalid structure, and duplicated content.
From `` `MemoryManager`1.xml` ``
```xml
The type of items in the memory buffer managed by this memory manager.
An abstract base class that is used to replace the implementation of .
` class is used to extend the knowledge of types that is able to represent. For example, you can derive from `MemoryManager` to allow to be backed by a .
> [!NOTE]
> The `MemoryManager` class is intended for advanced scenarios. Most developers do not need to use it.
]]>
```
Before porting the docs into triple slash comments, this was the content of `MemoryManager.cs`:
```csharp
///
/// Manager of that provides the implementation.
///
public abstract class MemoryManager : IMemoryOwner, IPinnable
```
After porting, this is the result:
```csharp
/// An abstract base class that is used to replace the implementation of .
/// The type of items in the memory buffer managed by this memory manager.
/// The `MemoryManager` class is used to extend the knowledge of types that is able to represent. For example, you can derive from `MemoryManager` to allow to be backed by a .
/// [!NOTE]
/// > The `MemoryManager` class is intended for advanced scenarios. Most developers do not need to use it.
/// ]]>
public abstract class MemoryManager : IMemoryOwner, IPinnable
```
The `` section has the content duplicated, once inside the `` and once before it, which is an invalid structure.
贡献指南
这个仓库没有索引到贡献指南
调研方向
将 MemoryManager`1.xml 中的 remarks 与 issue 中显示的生成后的 MemoryManager.cs 三斜杠注释进行比较。跟踪处理 remarks 和 format 元素的文档移植路径,然后验证生成的 remarks 具有有效结构,且没有重复内容。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- csharp
- 领域
- documentation, tooling
- Issue 类型
- 缺陷
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100