Dokumentation

Bibliotheksdokumentation Syntax

Angenommen, Sie veröffentlichen eine Bibliothek und möchten am Anfang der Datei lib.rs eine Dokumentation über die gesamte Bibliothek schreiben. Die Dokumentation sollte mit der folgenden Kommentarsyntax beginnen:

//! ist für die Dokumentation auf Modulebene geeignet, während /// für die Dokumentation einzelner Elemente wie Funktionen verwendet wird.

Cargo Test Fehler

Angenommen, Sie erstellen eine Bibliothek worldly mit der folgenden Funktion in lib.rs:

    /// Fügt den String "world" zu `s` hinzu.
    ///
    /// # Example
    /// ```
    /// let mut s = String::new();
    /// worldly::add_world(&mut s);
    /// assert_eq!(s, "Hello world");
    /// ```
    pub fn add_world(s: &mut String) {
        s.push_str("world");
    }

    #[test]
    fn test_add_world() {
        let mut s = String::new();
        add_world(&mut s);
        assert_eq!(s, "world");
    }

Wenn Sie cargo test ausführen, wird ein Test fehlschlagen?

Das inkorrekte Beispiel wird als Dokumentationstest ausgeführt und führt dazu, dass cargo test fehlschlägt.