< > ile çevrelenen dokümanlar dökümantasyona nasıl yorum eklenir

Question

Dokümantasyon yorumları yazmaya çalışıyorum ancak bir sorunum var.

/// <summary> 
/// Inserts an element into the System.Collections.Generic.List<T> at the specified 
/// index. 
/// </summary> 

Ben <T> Görsel stüdyo ben başka etiket eklemek çalışıyorum sanıyor ulaştığınızda. Bu şekilde yorum eklemenin doğru yolu nedir (ve eğer ekstra bir bonus olacak şekilde oluşturulan yardım metnini tıklatabilirlerse)

Answer 1

C# belgelerine yorumlar XML, bu nedenle < ve > için < ve > değiştirin.

Yapmaktan daha iyi olan şey, bununla birlikte, bir köprü eklemek için <see> etiketini kullanıyor. Bir <see> etiketinde, değiştirmek <T>{T} için:

/// <summary> 
/// Inserts an element into the <see cref="List{T}"/> at the specified 
/// index. 
/// </summary> 

(cref nitelik sözdizimi-kontrol sıradan metnin aksine, derleyici tarafından olduğunu unutmayın.) Bunun sizin için yardımcı olacağını düşünüyoruz

Answer 2

Yorum xml olduğundan, xml için uygun çıkış dizileri kullanabilirsiniz:

Xml nesnelerinden kaçış

/// Inserts an element into the System.Collections.Generic.List<T> at the specified 

Answer 3

.

 
Change <T> into &lt;T&gt; 

Answer 4

: C# XML documentation comments FAQ.

Answer 5

Uygun kodları kullanmanız gerekir: &lt; ve &gt;

Bir <see cref="..."/> etiketindeki tüm System.Collections.Generic.List <T> surreound isteyeyim

.

Aslında doğru bu cevabı :) yazmak için yukarıda belirtilen etiketleri kullanmak zorunda