dotnet / dotnet/api-docs-sync

cref values including generic types on method parameters get formatted incorrectly

Abierto
#67 1 comentario 0 reacciones 0 asignados Ver en GitHub
port-to-tripleslash
Lenguaje dominante
C#
Estrellas
14
Forks
21
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

While porting from API docs into triple slash comments, a scenario was encountered with `` elements that reference methods accepting generic arguments where the resulting triple slash comments are incorrectly formatted.

Example from `` ArrayPool`1.xml ``:

```xml
Indicates whether the contents of the buffer should be cleared before reuse.
If is set to , and if the pool will store the buffer
to enable subsequent reuse, the
method will clear the of its contents so that a subsequent caller using the
method will not see the content of the
previous caller. If is set to or if the pool will
release the buffer, the array's contents are left unchanged.
```

This results in:

```csharp
/// Indicates whether the contents of the buffer should be cleared before reuse.
If is set to , and if the pool will store the buffer
to enable subsequent reuse, the
method will clear the of its contents so that a subsequent caller using the
method will not see the content of the
previous caller. If is set to or if the pool will
release the buffer, the array's contents are left unchanged.
```

The `` is invalid. It should be ``.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.