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ı belgelere işlemek için ek araçlar kullanabilirsiniz.
Türler ve tür üyeleri gibi kod yapılarında XML yorumlarına izin verilir. Kısmi türler için, türünün yalnızca bir kısmı XML yorumlarına sahip olabilir, ancak üyelerini açıklama eklemek için herhangi bir kısıtlama yoktur.
Not
Belge açıklamaları ad alanlarına uygulanamaz. Bunun nedeni, bir ad alanının birçok derlemeyi yaymasına ve tüm derlemelerin aynı anda yüklenebilmesidir.
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>
- <code>
- <example>
- <exception>1
- <include>1
- <list>
- <para>
- <param>1
- <paramref>
- <permission>1
- <remarks>
- <returns>
- <see>1
- <seealso>1
- <summary>
- <typeparam>1
- <value>
(1 derleyici söz dizimini doğrular.)
Not
Bir 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 görünür <text in angle brackets> .