Skip to content

SA1625 - This rule is poorly named. #3917

Open
@simkin2004

Description

@simkin2004

The name of this rule reflects an action that was taken to get the code into a rule-breaking state, not the actual state that is the problem.

The Description of SA1625 is correct...
"The Xml documentation for a C# element contains two or more identical entries"
until the second phrase..
"indicating that the documentation has been copied and pasted."

/// <returns>A configured <see cref="WebApplicationBuilder"/>.</returns>/// <returns>A configured <see cref="WebApplicationBuilder"/>.</returns> public static WebApplicationBuilder

I can think of at least two other ways in the IDE to get into this state: bad merge & bad highlight & delete, neither of which describes the problem.

The -actual- problem is a duplicate tag for the same element, not the action I took to get into the bad state.

I would recommend changing this rule to something like:

ElementDocumentationMustNotBeDuplicated
or
ElementContainsTwoOrMoreIdenticalEntries (which would align with the documentation already provided).

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