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 eklemeye yönelik bir kısıtlama yoktur.

Not

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şlevleri sağlar.

• <C>
• <Kod>
• <Örnek>
• <özel durum1>
• <include1>
• <Liste>
• <para>
• <param1>
• <paramref>
• <izin1>
• <Açıklamalar>
• <Döndürür>
• <bkz>^{. 1}
• <seealso1>
• <Özet>
• <typeparam1>
• <Değer>

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

Not

Açılı ayraçların belge açıklaması metninde 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 bkz.

• XML ile Kodunuzu Belgeleme
• -doc
• Nasıl yapılır: XML Belgesi Oluşturma