dotnet / dotnet/api-docs-sync

cref values including generic types on method parameters get formatted incorrectly

Offen
#67 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
port-to-tripleslash
Vorherrschende Sprache
C#
Sterne
14
Forks
21
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.