Aracılığıyla paylaş

Belge Açıklamaları için Önerilen Etiketler (C# Programlama Kılavuzu)

  • Makale

C# derleyicisi kodunuzdaki açıklamalardan işler ve onları xml dosyasında belirttiğiniz adı olarak biçimlendiren /doc komut satırı seçeneği.Derleyici tarafından oluşturulan dosyasını temel alan son belgeler oluşturmak için özel bir araç oluşturabilir, veya bir aracı gibi kullanmak Sandcastle.

Etiketler, kod yapýlarýný türleri gibi işlenir ve üyeler yazın.

[!NOT]

Bir ad alanına açıklamalardan uygulanamaz.

Derleyici geçerli xml etiketi işleyecektir.Aşağıdaki etiketleri kullanıcı belgelerinde genellikle kullanılan işlevler sağlar.

Etiketler

<c>

<para>

<see>*

<code>

<param>*

<seealso>*

<example>

<paramref>

<summary>

<exception>*

<permission>*

<typeparam>*

<include>*

<remarks>

<typeparamref>

<list>

<returns>

<value>

(* derleyici sözdizimini doğrular gösterir.)

Açılı ayraçlar belgelere açıklama metninde görünmesini isterseniz, &lt; ve &gt;, aşağıdaki örnekte gösterildiği gibi.

/// <summary cref="C &lt; T &gt;">
/// </summary>

Ayrıca bkz.

Başvuru

/doc (C# Derleyici Seçenekleri)

XML Belgeleri Yorumları (C# Programlama Kılavuzu)

Kavramlar

C# Programlama Kılavuzu