Skip to content

Lint for 4 / (////) to help detect broken doc comments #9212

Closed
@alice-i-cecile

Description

@alice-i-cecile

What it does

Detects four consecutive forward slash characters.

This is almost always indicative of a broken doc comment.

Lint Name

four-forward-slashes

Category

suspicious

Advantage

  • The doc comment appears as expected.

Drawbacks

Users may have a non-standard style that uses 4 forward slashes semantically.

Example

//// The life total of a unit
struct Life(u8);

Was likely intended to be:

/// The life total of a unit
struct Life(u8);

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-lintArea: New lints

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions