Rust 程式設計視訊教程(進階)——007_3 文件註釋(pub use 匯出合適的公有 API)

linghuyichong發表於2020-01-21

頭條地址:https://www.ixigua.com/i677586170644791348...
B站地址:https://www.bilibili.com/video/av81202308/

使用pub use匯出合適的公有API
例子1:

//! # Art
//!
//! 一個描述美術資訊的庫。
pub mod kinds {
    /// 採用 RGB 色彩模式的主要顏色。
    pub enum PrimaryColor {
        Red,
        Yellow,
        Blue,
    }
    /// 採用 RGB 色彩模式的次要顏色。
    pub enum SecondaryColor {
        Orange,
        Green,
        Purple,
    }
}

pub mod utils {
    use crate::kinds::*;
    /// 等量的混合兩個主要顏色
    /// 來建立一個次要顏色。
    pub fn mix(c1: PrimaryColor, c2: PrimaryColor) -> SecondaryColor {
        SecondaryColor::Orange
    }
}

//========================================
例子2:

//! # Art
//!
//! 一個描述美術資訊的庫。
//+++++以下為例子2新增部分+++++++++
pub use kinds::PrimaryColor;
pub use kinds::SecondaryColor;
pub use utils::mix;
//+++++++++++++++++++++++++++++++
pub mod kinds {
    /// 採用 RGB 色彩模式的主要顏色。
    pub enum PrimaryColor {
        Red,
        Yellow,
        Blue,
    }
    /// 採用 RGB 色彩模式的次要顏色。
    pub enum SecondaryColor {
        Orange,
        Green,
        Purple,
    }
}

pub mod utils {
    use crate::kinds::*;
    /// 等量的混合兩個主要顏色
    /// 來建立一個次要顏色。
    pub fn mix(c1: PrimaryColor, c2: PrimaryColor) -> SecondaryColor {
        SecondaryColor::Orange
    }
}

執行cargo doc --open後觀察兩者的不同

本作品採用《CC 協議》,轉載必須註明作者和本文連結

令狐一衝

相關文章