77得票5回答
如何在rustdoc中链接到其他函数/结构体/枚举/特性?

我正在构建一个Rust库并想要它更加完善。在 rustdoc 中,我有时想要在文档中链接到库中的其他部分,例如 fn、trait 或 struct。这个官方的语法是什么?

50得票3回答
如何记录Rust函数的参数?

rustdoc允许您通过在每行上方包含文档注释来记录结构字段和枚举变体。 enum Choices { /// The first choice. First, /// The second choice. Second, } struct Person { /// T...

31得票2回答
如何防止`rust doc`将依赖项添加到文档中?

我刚开始接触 Rust,尝试为我编写的代码生成文档。当我输入“cargo doc”时,看到了一些奇怪的东西。 21:53 $ cargo doc Compiling regex-syntax v0.2.2 Compiling libc v0.2.2 Compiling me...

23得票2回答
如何在`cargo doc`生成的文档中获取功能需求标签?

如果您查看docs.rs上的Tokio文档,会有一个蓝色标签,表示必须激活某个功能才能访问此API: 我也想为我的包启用这个功能,应该如何操作?

16得票1回答
`cargo doc` 和 `cargo rustdoc` 有什么不同?

根据doc.rust-lang.org cargo rustdoc 使用指定的自定义标志构建软件包的文档 cargo doc 构建软件包的文档 这两者有什么区别?据我所知,cargo rustdoc与cargo doc类似,但它允许更多的lints,例如: #![d...

14得票2回答
有没有一种方法可以从文档中隐藏宏模式?

截至Rust 1.6.0版本,生成的文档隐藏了每个宏模式的实现: 有没有办法在Cargo生成的文档中隐藏某些模式? macro_rules! mc { // hide this entire pattern (@impl, $arg:expr) => { 42 +...

11得票1回答
如何在 Rust 源码注释文档中包含 ASCII 艺术/图表?

如何在rustdoc中使用Markdown来包含图表或ASCII艺术? 从手册中可以看出,三个反引号可以用于代码片段。但是如何包含字面上的非格式化文本呢? (类似于Doxygen的<pre>...</pre>)

11得票2回答
文档示例中存在未解决的导入问题。

我在为我的库修复文档示例中的错误时遇到了困难。我的crate的文件结构如下:bignum. |-- Cargo.lock |-- Cargo.toml |-- examples | |-- dat | | `-- euler_13.dat | |-- debug.rs | ...

9得票1回答
如何为私有项目生成文档

我有一个项目,其中包括: main.rs module_1/mod.rs module_2/mod.rs module_2/module_3/mod.rs 当我运行时,我只能得到main.rs的文档,而不能得到模块的文档。 在我的main.rs文件中,我有: mod module_1...

9得票1回答
使用rustdoc生成markdown文档?

有没有办法从 /// 注释中生成一个位于 doc/ 目录下的单个 markdown 文件? 同时生成多个 markdown 文件(例如: doc/main.md, doc/foo.md 等)也会很好。 我是 rust 的新手,虽然生成的 HTML 文档很好,但我大部分时间都在命令行上工作,...