Я строю библиотеку Rust и хочу дать ей немного польского. В rustdoc мне иногда хотелось бы ссылаться на другие части библиотеки в документах, например. fn s, trait или struct s. Каков официальный синтаксис для этого?
Как связать с другими fns/structs/enums/traits в rustdoc?
Ответ 1
Rustdoc похоже, генерирует в основном детерминированные имена файлов для составных элементов ящика. Поэтому, если у вас есть enum с именем Complex, вы можете в целом ссылаться на него, используя:
[Complex](enum.Complex.html)
Аналогично a struct, называемый Point, будет выглядеть так:
[Point](struct.Point.html)
Это должно переноситься на большинство определений (fn, trait и т.д.).
Я должен отметить, что это может не работать в определенных ситуациях. Если по какой-либо причине файлы HTML, созданные с помощью Rustdoc, заканчиваются на разных уровнях вложенности, относительные ссылки, перечисленные выше, могут 404. У меня еще не было этой проблемы.
Ответ 2
Поскольку документация написана в Markdown, просто используйте синтаксис Markdown для гиперссылок; то есть.
[anchor text](URL)
Кроме того, взгляните на это: https://doc.rust-lang.org/book/documentation.html