Sto costruendo una libreria Rust e voglio dargli un po 'di lucidatura. Nel rugdoc, a volte mi piacerebbe creare il collegamento in altre parti della libreria all'interno dei documenti, ad es. fn s, trait s oppure struct s. Qual è la sintassi ufficiale per questo?Come collegarsi ad altri fns/structs/enums/traits in rustdoc?
Rustdoc sembra generare i nomi dei file per lo più deterministici per gli elementi costitutivi di una cassa. Quindi se avete un enum nome Complex in generale si può collegare ad esso utilizzando:
[Complex](enum.Complex.html)
Allo stesso modo un struct chiamato Point sarebbe simile:
[Point](struct.Point.html)
Questo dovrebbe portare verso la maggior parte delle definizioni (fn, trait , e così via).
Si noti che questo potrebbe non funzionare in determinate situazioni. Se, per qualsiasi motivo, i file HTML generati da rustdoc finiscono con livelli diversi di nidificazione, i collegamenti relativi che ho elencato sopra possono 404. Non ho ancora avuto questo problema.
Poiché la documentazione è scritta in Markdown, è sufficiente utilizzare la sintassi Markdown per collegamenti ipertestuali; vale a dire
[anchor text](URL)
Inoltre, dare un'occhiata a questo: https://doc.rust-lang.org/book/documentation.html
Questo in realtà non risponde alla domanda, perché non penso che ci sia un modo per capire l'URL. – kralyk
ci sono state alcune discussioni qui: https://internals.rust-lang.org/t/rustdoc-link-to-other-types-from-doc-comments/968 –
e un rfc aperto qui: https: //github.com/rust-lang/rfcs/issues/792 –