Rust errors / Everything else
Rust compiler error · checked with rustc 1.99.0
Rust error E0584: found a documentation comment that doesn't document anything
What it meansA doc comment that is not attached to anything has been encountered.
What rustc prints
error[E0584]: found a documentation comment that doesn't document anything --> main.rs:4:5 | 4 | /// I'm lost! | ^^^^^^^^^^^^^ this doc comment doesn't document anything | = help: doc comments must come before what they document, if a comment was intended use `//`
Real output of rustc 1.99.0 compiling the official example below (2021 edition). Your names and line numbers will differ; the first line is the part to match.
The compiler team's explanation
A doc comment that is not attached to anything has been encountered.
Erroneous code example:
trait Island {
fn lost();
/// I'm lost!
}A little reminder: a doc comment has to be placed before the item it's supposed to document. So if you want to document the Island trait, you need to put a doc comment before it, not inside it. Same goes for the lost method: the doc comment needs to be before it:
/// I'm THE island!
trait Island {
/// I'm lost!
fn lost();
}From rustc --explain E0584 (1.99.0), part of the Rust project, MIT or Apache-2.0. Official page.
Related errors
- E0061this function takes N arguments but M were supplied
- E0412cannot find type in this scope
- E0515cannot return reference to local variable
- E0728await is only allowed inside async functions and blocks
- E0571`break` with value from a `while` loop
- E0572return statement outside of function body
- E0585found a documentation comment that doesn't document anything
- E0586inclusive range with no end
Up next
Often hit nextE0061: this function takes N arguments but M were suppliedA related error from the same family.Read it next →Did this answer your question?