标签：doc 生成 注释 文档 rust hello Rust

环境

• Rust 1.54.0
• VSCode 1.59.1

概念

参考：https://doc.rust-lang.org/stable/rust-by-example/hello/comment.html
文档注释（doc comments）：文档注释会对外公开，使用者一般在使用之前，会进行阅读。
文档注释包含两种，这里介绍第二种：

• /// 为接下来的项（the following item）生成注释，一般是函数。
• //! 为整个项生成注释，一般是整个文件。

文档注释可以生成 html 查看，支持 markdown 格式。

示例

文档注释

//! # Hello World
//!
//! 编写的第一个 `Hello World` 程序
//!

/// 主函数
fn main() {
    let x = 1;
    println!("{}", x);
}

/// 加法函数
fn add(x: i32, y: i32) -> i32 {
    x + y
}

生成文档

可以使用命令 cargo doc 来生成文档注释的 html 格式，在 target/doc 目录下：

PS C:\Users\jiangbo\work\workspace\rust\hello_world> cargo doc
 Documenting hello_world v0.1.0 (C:\Users\jiangbo1446\work\workspace\rust\hello_world)
    Finished dev [unoptimized + debuginfo] target(s) in 0.79s

生成文档并打开

如果想直接查看文档，可以打开生成的文档，也可以直接使用 cargo doc --open 命令。

总结

介绍了 Rust 中的文件文档注释的使用方式，生成、打开、查看文档注释。

附录

标签：doc,生成,注释,文档,rust,hello,Rust
来源： https://www.cnblogs.com/jiangbo44/p/15626678.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。