dotnet / dotnet/api-docs-sync

cref values including generic types on method parameters get formatted incorrectly

Aperta
#67 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
port-to-tripleslash
Lingua principale
C#
Stelle
14
Fork
21
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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 ``.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.