dotnet / dotnet/api-docs-sync

cref values including generic types on method parameters get formatted incorrectly

オープン
#67 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
port-to-tripleslash
主要言語
C#
スター
14
フォーク
21
PR マージ指標
30日以内にマージされた PR はありません

説明

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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。