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?
risposta
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
- 1. kubernetes baccello non può collegarsi (attraverso il servizio) per sé, solo ad altri pod contenitori
- 2. Come collegarsi ad Android Marketplace Review dall'interno dell'app?
- 3. Come posso collegarmi ad altri programmi in Windows?
- 4. Come iscriversi ad altri eventi di classe in C#?
- 5. Collegamento ad altri file di giada
- 6. Xcode diviso NSString ad altri NSStrings
- 7. percorsi relativi partial riferimento ad altri partial
- 8. Audio streaming Android ad altri dispositivi
- 9. Come collegarsi a cpp-netlib
- 10. Come inviare file ad altri iPhone tramite Bluetooth
- 11. come inviare il mio gioco fatto con pygame ad altri?
- 12. Come scattare elementi ad altri elementi trascinabili con interact.js
- 13. Come assegnare risorse WPF ad altri tag risorsa
- 14. spedizione di moduli python in pyspark ad altri nodi?
- 15. Modificare il valore del modello in base ad altri valori?
- 16. Come verificare se un elemento si sovrappone ad altri elementi?
- 17. Doxygen - Come collegarsi alla pagina Moduli
- 18. Come collegarsi alle pagine senza l'estensione .html?
- 19. Perl invia ad altri interpreti in base alla linea shebang?
- 20. Posso fare riferimento ad altri slot in una defstruct?
- 21. cl.h non trovato - come collegarsi a makefile
- 22. Come collegarsi alle librerie di boost dinamiche?
- 23. Come accedere ad altri vertici in un programma vertex shader in opengl es 2?
- 24. Modo elegante per rendere logging.LoggerAdapter disponibile ad altri moduli
- 25. Codice locale per l'ebraico/Riferimento ad altri codici locali?
- 26. come collegarsi a Firebird DB su Android
- 27. Come collegarsi a un diverso file libc?
- 28. Passaggio di un operatore insieme ad altri parametri
- 29. campata verticalmente centro (etichetta bootstrap) insieme ad altri elementi
- 30. iscriversi ad una tavola più volte per altri tavoli
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 –