language - rust learn

¿Cómo enlazar con otros fns/structs/enums/traits en rustdoc?

Question

Estoy construyendo una biblioteca Rust y quiero darle un poco de pulido. En rustdoc, a veces me gustaría enlazar con otras partes de la biblioteca dentro de los documentos, por ejemplo, fn s, trait s o struct s. ¿Cuál es la sintaxis oficial de esto?

Answer 1

Dado que la documentación está escrita en Markdown, solo use la sintaxis de Markdown para los hipervínculos; es decir

[anchor text](URL)

También, eche un vistazo a esto: https://doc.rust-lang.org/book/documentation.html

Answer 2

Rustdoc parece generar nombres de archivos en su mayoría deterministas para los elementos constitutivos de una caja. Por lo tanto, si tiene una enum llamada Complex , generalmente puede vincularlo usando:

[Complex](enum.Complex.html)

De manera similar, una struct llamada Point se vería así:

[Point](struct.Point.html)

Esto debería pasar a la mayoría de las definiciones ( fn , trait , etc.).

Debo tener en cuenta que esto podría no funcionar en ciertas situaciones. Si, por alguna razón, los archivos HTML generados por rustdoc terminan en diferentes niveles de anidamiento, los enlaces relativos que he enumerado anteriormente pueden ser 404 . No he tenido este problema todavía.