我正在建一个 rust 迹斑斑的图书馆,想把它润色一下.在rustdoc中,我有时想将link转到文档中库的其他部分,例如fns、traits或structs.这个的官方语法是什么?

推荐答案

As of Rust 1.48, Rustdoc now supports direct intra-doc links.


Pre Rust 1.48:

Rustdoc似乎为 crate 的组成元素生成了大部分确定性文件名.因此,如果您有一个名为Complexenum,通常可以使用以下链接:

[Complex](enum.Complex.html)

类似地,一个名为Pointstruct看起来像:

[Point](struct.Point.html)

这应该适用于大多数定义(fntrait等).

要在不同嵌套级别引用 crate 的元素,可以使用相对路径(其中每个模块都是自己的文件夹):

[Point](../model/struct.Point.html)

或者使用绝对路径:

[Point](/crate_name/model/struct.Point.html)

如果一个人构建文档(cargo doc --no-deps --open)并导航到他们想要的字段或项目,并注意URL,则可以推断出更多这些"约定",包括特定字段的锚定等.请记住,只有发布项目才会发布到文档中.

Rust相关问答推荐

将已知大小的切片合并成一个数组,

同时从不同线程调用DLL的不同函数会出现分段错误或产生STATUS_STACK_BUFFER_OVERRUN

替换可变引用中的字符串会泄漏内存吗?

是否可以使用Rust宏来构建元组的项?

RUST应用程序正在退出,错误代码为:(退出代码:0xc0000005,STATUS_ACCESS_VIOLATION)

为什么';t std::cell::ref使用引用而不是非空?

为什么Deref类特征不构成?

通过异常从同步代码中产生yield 是如何工作的?

为什么我需要 to_string 函数的参考?

在使用粗粒度锁访问的数据 struct 中使用 RefCell 是否安全?

`UnsafeCell` 在没有锁定的情况下跨线程共享 - 这可能会导致 UB,对吗?

枚举的利基优化如何在 Rust 中工作?

内部值发生变化时 Rc 的行为

是否可以在 Rust 中的特定字符上实现特征?

使用 HashMap 条目时如何避免字符串键的短暂克隆?

为什么分配对变量的引用使我无法返回它

TinyVec 如何与 Vec 大小相同?

基于名称是否存在的条件编译

list 中没有指定目标 - 必须存在 src/lib.rs、src/main.rs、[lib] 部分或 [[bin]] 部分

为什么 u64::trailing_zeros() 在无分支工作时生成分支程序集?