cref values including generic types on method parameters get formatted incorrectly
- Langage dominant
- C#
- Étoiles
- 14
- Forks
- 21
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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 ``.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Piste de recherche
Start by reproducing the conversion using the ArrayPool`1.xml example and trace how the API docs sync tool formats cref values for generic method parameters. Done means the generated triple-slash comment uses a valid cref such as ArrayPool{T}.Return(T[], bool) instead of placeholders like {T} in the parameter type.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- csharp
- Domaine
- documentation
- Type d'issue
- Bug
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100