Rust errors / Everything else
Rust compiler error · checked with rustc 1.99.0
Rust error E0753: expected outer doc comment
What it meansAn inner doc comment was used in an invalid context.
What rustc prints
error[E0753]: expected outer doc comment --> main.rs:2:1 | 2 | //! foo | ^^^^^^^ 3 | // ^ error! 4 | fn main() {} | ------------ the inner doc comment doesn't annotate this function | help: to annotate the function, change the doc comment from inner to outer style | 2 - //! foo 2 + /// foo |
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.
E0753Everything else
Activein rustc 1.99.0
8related errors linked below
The compiler team's explanation
An inner doc comment was used in an invalid context.
Erroneous code example:
fn foo() {}
//! foo
// ^ error!
fn main() {}Inner document can only be used before items. For example:
//! A working comment applied to the module!
fn foo() {
//! Another working comment!
}
fn main() {}In case you want to document the item following the doc comment, you might want to use outer doc comment:
/// I am an outer doc comment
#[doc = "I am also an outer doc comment!"]
fn foo() {
// ...
}From rustc --explain E0753 (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
- E0733recursion in an async fn requires boxing
- E0752`main` function is not allowed to be `async`
- E0758unterminated block comment
- E0762unterminated character literal
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?