如何在GitHub及本地查看Rust项目的///格式文档？

本地查看方法 #

• 生成并打开完整HTML文档：在项目根目录的终端执行命令 cargo doc --open。该命令会自动解析你的///注释，生成标准格式的HTML文档，并直接在默认浏览器中打开。你能在文档里找到CarryOn函数的详细说明，格式和Rust官方标准库文档一致。
• VS Code内快速查看：直接把鼠标悬停在代码中的CarryOn函数名上，VS Code会即时弹出包含你编写的///注释的提示框，无需额外操作。

GitHub上查看方法 #

GitHub本身不会自动渲染Rust的///注释为可读文档，你可以通过以下方式解决：

• 上传本地生成的文档到GitHub Pages：先在本地用cargo doc生成target/doc目录下的HTML文件，将这些文件单独放到仓库的一个分支（比如gh-pages），然后在仓库的Settings里开启GitHub Pages，选择该分支作为来源，之后就能通过指定URL在线查看渲染后的文档。
• 在README中同步关键注释：把函数、结构体等的核心注释内容提取到项目的README.md文件中，方便其他访问仓库的开发者快速了解代码功能。
• 提示其他用户本地生成：在README里说明执行cargo doc --open即可查看完整文档，引导其他开发者自行生成查看。

你的示例代码（带文档注释）：

/// The "CarryOn()" function is used for determining if the user wants to add more words to the glossary.
/// The user can input 1 to continue, or any other number to quit.
fn CarryOn()->i8{
    println!("Do you want to continue ending words to the glossary?");
    println!("Press 1 for yes, enter any other number for no.");
    let mut s1 = String::new();
    io::stdin().read_line(&mut s1).expect("Failed");
    let n1:i8 = s1.trim().parse().expect("Not a valid Number");
    return n1;
}

内容的提问来源于stack exchange，提问作者John