Làm thế nào để liên kết với các fns/structs/enums/đặc điểm khác trong rustdoc?

Question

Tôi đang xây dựng một thư viện Rust và muốn cho nó một số đánh bóng. Trong rustdoc, đôi khi tôi muốn liên kết với các phần khác của thư viện trong tài liệu, ví dụ: fn s, trait s hoặc struct s. Cú pháp chính thức cho điều này là gì?

Answer 1

Rustdoc dường như để tạo ra tên tập tin chủ yếu là xác định cho các yếu tố cấu thành của một thùng. Do đó, nếu bạn có một enum tên Complex bạn có thể thường liên kết với nó sử dụng:

[Complex](enum.Complex.html) 

Tương tự một struct gọi Point sẽ trông như thế:

[Point](struct.Point.html) 

này nên chuyển sang hầu hết các định nghĩa (fn, trait , v.v.)

Tôi nên lưu ý rằng điều này có thể không hoạt động trong một số trường hợp nhất định. Nếu vì bất kỳ lý do gì, các tệp HTML được tạo bởi rustdoc sẽ kết thúc ở các cấp độ lồng nhau khác nhau, các liên kết tương đối mà tôi đã liệt kê ở trên có thể là 404. Tôi chưa có vấn đề này.

Answer 2

Vì tài liệu được viết trong Markdown, chỉ cần sử dụng cú pháp Markdown cho siêu liên kết; ví dụ:

[anchor text](URL) 

Ngoài ra, hãy xem này: https://doc.rust-lang.org/book/documentation.html