xml belgesi açıklamalarının (C# Programlama Kılavuzu)

Visual C# [NULL]'ta, belgeleri kodunuz için kaynak kodunu doğrudan başvuruda kod bloğunu önce özel yorum alanlarındaki xml etiketleri ekleyerek oluşturabilirsiniz. Örne?in:

/// <summary>
///  This class performs an important function.
/// </summary>
public class MyClass{}

Ne zaman, derleme ile /doc derleyici tüm xml etiketleri kaynak kodu ve bir xml belgesi dosyası oluşturmak için arama yapar. Derleyici tarafından oluşturulmuş dosyaya dayalı son belgeler oluşturmak için özel bir araç oluşturabilir, veya bir aracı gibi kullanmak Sandcastle.

Not

xml Belge açıklama meta değildir; derlenmiş derleme bulunmayan ve bu nedenle bunlar yansıtma üzerinden erişilebilir değil.

Bu Bölümde

• Etiketler belgeleme yorumları için önerilen

• xml dosyası işleniyor

• Sınırlayıcılar belgelerine etiketler için

• Nasıl yapılır: xml belgelerine özelliklerini kullanma

İlgili Bölümler

Daha fazla bilgi için bkz:

• /doc (İşlem Belgelerinin Açıklamaları)

C# dil belirtiminin

Daha fazla bilgi için bkz: C# dil belirtiminin. Dil belirtimi, C# sözdizimi ve kullanımı için nihai kaynaktır.

Ayrıca bkz.

Kavramlar

C# Programlama Kılavuzu