2015-07-23 20 views
24

Bir Rust kütüphanesi yapıyorum ve biraz cila vermek istiyorum. Pasdok'ta, bazen kitaplıktaki diğer bölümlere bağlantı bağlantısını isterim. fn s, trait s veya struct s. Bunun resmi sözdizimi nedir?Pasiflerde diğer fns/structs/enums/traits ile bağlantı nasıl yapılır?

+2

burada bazı tartışma olmuştur: https://internals.rust-lang.org/t/rustdoc-link-to-other-types-from-doc-comments/968 –

+3

ve burada açık bir rfc: https: //github.com/rust-lang/rfcs/issues/792 –

cevap

12

Rustdoc bir sandık kurucu unsurları çoğunlukla deterministik dosya oluşturmak gibi görünüyor. Bir enum adında var nedenle eğer Complex kullanmakta buna genellikle bağlayabilirsiniz:

[Complex](enum.Complex.html) 

Benzer bir struct gibi görünür Point seslendi: Bu en tanımlara (fn de uygulanması

[Point](struct.Point.html) 

, trait , ve bunun gibi).

Bu 'un belirli durumlarda çalışmayabilir. Hangi nedenle olursa olsun, rustdoc tarafından oluşturulan HTML dosyaları farklı yuvalanma düzeylerinde sona ererse, yukarıda listelediğim göreli bağlantılar 404 olabilir. Henüz bu problemi almadım.

2

Dokümantasyon, Markdown'da yazıldığından, sadece Köprüler için Markdown sözdizimini kullanın; yani

[anchor text](URL) 

Ayrıca, bu bir göz atın: https://doc.rust-lang.org/book/documentation.html

+6

Bu soruya gerçekten cevap vermiyor çünkü URL'yi anlamanın bir yolu olduğunu düşünmüyorum. – kralyk

İlgili konular