Rust errors / Everything else
Rust compiler error · checked with rustc 1.99.0
Rust error E0585: found a documentation comment that doesn't document anything
What it meansA documentation comment that doesn't document anything was found.
What rustc prints
error[E0585]: found a documentation comment that doesn't document anything --> main.rs:3:5 | 3 | /// This is a useless doc comment! | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = 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.
E0585Everything else
Activein rustc 1.99.0
8related errors linked below
The compiler team's explanation
A documentation comment that doesn't document anything was found.
Erroneous code example:
fn main() {
// The following doc comment will fail:
/// This is a useless doc comment!
}Documentation comments need to be followed by items, including functions, types, modules, etc. Examples:
/// I'm documenting the following struct:
struct Foo;
/// I'm documenting the following function:
fn foo() {}From rustc --explain E0585 (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
- E0572return statement outside of function body
- E0584found a documentation comment that doesn't document anything
- E0586inclusive range with no end
- E0590`break` or `continue` with no label in the condition of a `while` loop
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?