ThinkChat2.0新版上线,更智能更精彩,支持会话、画图、视频、阅读、搜索等,送10W Token,即刻开启你的AI之旅 广告
cargo doc命令为你的库创建html文档。加--no-deps选项让rust只生成库自己的文档,不生成它所依赖的库的文档。加--open选项会在浏览器中打开生成的文档。cargo生成的帮助文档在target/doc目录,主页是target/doc/库名/index.html。文档生成来源是库里面所有的公有项加上相应的文档注释。 文档注释可以用#[doc="..."]注解来声明,也可以用3个斜杠来表示,它们是等价的。 当你编译或者测试一个库的时候这些注解被忽略,当你生成文档的时候,公有项的文档注解会输出到文档。 //!和3个斜杠类似,只是它为闭合块注释,用于模块或者包生成文档。 文档注释的内容被认为是markdown格式的,然而你可以回退到html,在文档注释里的任意html标签都会原封不动地生成到文档中。 你可以在文档注释中包含代码片段,用4个空格的缩进来表示或者用markdown的代码块标记(两个```包住),两种方法是等效的。不管你用哪种方式,里面的代码片段都会被认为是测试,cargo test的时候会被运行。