Ich baue eine Rust-Bibliothek und möchte sie etwas polieren. Im rustdoc würde ich manchmal gerne Link zu anderen Teilen der Bibliothek innerhalb der Dokumente, z. fn s, trait s oder struct s. Was ist die offizielle Syntax dafür?Wie verlinkt man zu anderen fns/structs/enums/traits in rustdoc?
Rustdoc scheint für Bestandteile einer Kiste meist determinisDateiNamen zu erzeugen. Deshalb, wenn Sie haben ein enum namens Complex Sie können in der Regel verknüpfen, um es mit:
[Complex](enum.Complex.html)
Ähnlich ein structPoint genannt aussehen würde:
[Point](struct.Point.html)
Dies sollte für die meisten Definitionen tragen über (fn, trait , und so weiter).
Ich sollte beachten, dass diese in bestimmten Situationen möglicherweise nicht funktioniert. Wenn aus irgendeinem Grund die HTML-Dateien, die von rustdoc generiert werden, auf verschiedenen Ebenen der Verschachtelung enden, können die relativen Links, die ich oben aufgeführt habe, 404. Ich habe dieses Problem noch nicht gehabt.
Da die Dokumentation in Markdown geschrieben wird, verwenden Sie einfach die Markdown-Syntax für Hyperlinks; das heißt
[anchor text](URL)
Werfen Sie auch einen Blick auf diese: https://doc.rust-lang.org/book/documentation.html
Das beantwortet die Frage nicht wirklich, weil ich glaube nicht, dass es einen Weg gibt, die URL herauszufinden. – kralyk
Es gab einige Diskussion hier: https://internals.rust-lang.org/t/rustdoc-link-to-other-types-from-doc-comments/968 –
und eine offene rfc hier: https: //github.com/rust-lang/rfcs/issues/792 –