dotnet / dotnet/docfx

[Feature Request] Handle duplicate parameter comments better

Open
#10,887 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

Currently for this code:
```cs
///
/// Get by ID.
///
/// The ID.
public int GetById(string id)
{
throw null!;
}

///
///
/// Whether the ID is case sensitive.
public int GetById(string id, bool ignoreCase)
{
throw null!;
}
```
the warning `Duplicate parameter 'id' found in comments, the latter one is ignored.` is reported by docfx. The empty `` in the latter method is there to prevent the [CS1573](https://learn.microsoft.com/en-us/dotnet/csharp/misc/cs1573?f1url=%3FappId%3Droslyn%26k%3Dk(CS1573)) warning from being reported while keeping the inherited xml doc from the former method. I think it would be nice if docfx handled such a case and ignored empty xml docs so that this warning isn't reported.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.