Belge Açıklamaları için Önerilen XML Etiketleri (Visual Basic)

Visual Basic derleyicisi, kodunuzdaki belge açıklamalarını bir XML dosyasına işleyebilir. XML dosyasını belgeler halinde işlemek için ek araçlar kullanabilirsiniz.

Tür ve tür üyeleri gibi kod yapılarında XML açıklamalarına izin verilir. Kısmi türler için türün yalnızca bir bölümü XML açıklamalarına sahip olabilir, ancak üyelerine açıklama eklemeyle ilgili bir kısıtlama yoktur.

Uyarı

Belge açıklamaları ad alanlarına uygulanamaz. Bunun nedeni, bir ad alanının birkaç derlemeye yayılabilmesi ve tüm derlemelerin aynı anda yüklenmesi gerekmemesidir.

Derleyici geçerli XML olan herhangi bir etiketi işler. Aşağıdaki etiketler, kullanıcı belgelerinde yaygın olarak kullanılan işlevselliği sağlar.

• <c>
• <kod>
• <örnek>
• <özel durum>¹
• <1'i dahil et>
• <liste>
• <para>
• <param>¹
• <paramref>
• <izin>¹
• <Açıklamalar>
• <Döndürür>
• <bkz>^{. 1}
• <seealso>¹
• <özet>
• <typeparam>¹
• <typeparamref>
• <değer>

(¹ Derleyici söz dizimini doğrular.)

Uyarı

Belge açıklamasının metninde açılı ayraçların görünmesini istiyorsanız ve <kullanın>. Örneğin, dize "<text in angle brackets>" olarak <text in angle brackets>görünür.

Ayrıca bakınız

• Kodunuzu XML ile Belgeleme
• -doküman
• Nasıl yapılır: XML Belgeleri Oluşturma