Wie kann ich kistenweite Dokumentation schreiben?

Um sicherzustellen, dass alle öffentlichen Artefakte meiner Kiste dokumentiert sind (wenn zumindest am Anfang), habe ich @ angegebe#![deny(missing_docs)] in meinemlib.rs, aber es ging nach hinten los.

Ich habe erwartet, dass der Code so geschrieben wird, das ist der Dokumentationskommentar oben und der Code danach:

/// Hello world example for Rust.

#![deny(missing_docs)]

fn main() {
    println!("Hello world!");
}

Dies schlägt fehl mit:

3:3: 3:4 error: an inner attribute is not permitted in this context
3 #![deny(missing_docs)]

Rückgängig machen der Reihenfolge, Attribute zuerst und Kommentar zweitens:

#![deny(missing_docs)]

/// Hello world example for Rust.

fn main() {
    println!("Hello world!");
}

Auch schlägt fehl:

1:1: 7:1 error: missing documentation for crate
1 #![deny(missing_docs)]

nd nirgendwo im Buch Dokumentation Abschnitt finde ich heraus, wie ich Dokumentation für die Kiste selbst schreibe.

So, wie soll ich die Kistendokumentation schreiben, um @ zu befriedig#![deny(missing_docs)]?

Antworten auf die Frage(2)

Ihre Antwort auf die Frage