Skip to content

[Feature Request] Handle duplicate parameter comments better #10887

@KubaZ2

Description

@KubaZ2

Currently for this code:

    /// <summary>
    /// Get by ID.
    /// </summary>
    /// <param name="id">The ID.</param>
    public int GetById(string id)
    {
        throw null!;
    }

    /// <inheritdoc cref="GetById(string)" />
    /// <param name="id" />
    /// <param name="ignoreCase">Whether the ID is case sensitive.</param>
    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 <param name="id" /> in the latter method is there to prevent the 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions