Rust 编程视频教程(进阶)——007_3 文档注释(pub use 导出合适的公有 API)
视频地址
头条地址: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 协议》,转载必须注明作者和本文链接
推荐文章: