Warn on accidental triple-slash doc comment ///!

[SabrinaJewson]

What it does

Checks for use of ///! and warns against it. For example:

///! This crate does cool things.

pub fn example() {}

It’s not immediately obvious, but the doc comment is attached to the wrong item.

Lint Name

suspicious_doc_comment

Category

suspicious

Advantage

Users are less likely to make this mistake and be confused by it / have worse documentation because of it.

Drawbacks

Nothing I can think of.

Example

///! This crate does cool things.

pub fn example() {}

Could be written as:

//! This crate does cool things.

pub fn example() {}