Rust 程序设计语言 简体中文版 1.85.0HTML 文档。这些 HTML 展示公有 API 文档注释的内容,它们意在让对库感兴趣的程序员理解如何使用这个 crate,而不是它是如何被实现的。 文档注释使用三斜杠 /// 而不是双斜杠以支持 Markdown 注解来格式化文本。文档注释就位 于需要文档的项的之前。示例 14-1 展示了一个 my_crate crate 中 add_one 函数的文档注释。 文件名:src/lib.rs /// 所示: 302/562Rust 程序设计语言 简体中文版 图 14-1:add_one 函数的文档注释 HTML 常用(文档注释)部分 示例 14-1 中使用了 # Examples Markdown 标题在 HTML 中创建了一个以 “Examples” 为标 题的部分。其他一些 crate 作者经常在文档注释中使用的部分有: • Panics:这个函数可能会 panic! 的场景。并0 码力 | 562 页 | 3.23 MB | 24 天前3
共 1 条
- 1













