XML belgeleri (Visual C++)
Visual C++'da, kaynak kodunuza xml belge dosyasına işlenen açıklamalar ekleyebilirsiniz. Bu dosya daha sonra kodunuzdaki sınıflar için belgeler oluşturan bir işlemin girişi olabilir.
Visual C++ kod dosyasında, XML belge açıklamalarının bir yöntem veya tür tanımı öncesinde doğrudan bulunması gerekir. Açıklamalar, aşağıdaki senaryolarda IntelliSense QuickInfo veri ipucunu doldurmak için kullanılabilir:
Kod bir WINMD dosyasıyla Windows Çalışma Zamanı bileşeni olarak derlendiğinde
Kaynak kodu geçerli projeye dahil edildiğinde
Tür bildirimleri ve uygulamaları aynı üst bilgi dosyasında bulunan bir kitaplıkta
Not
Geçerli sürümde, kod açıklamaları şablonlarda veya şablon türü içeren herhangi bir işlemde (örneğin, parametreyi şablon olarak alan bir işlev) işlenmez. Bu tür açıklamalar eklemek tanımsız davranışa neden olur.
Belge açıklamaları içeren bir XML dosyası oluşturma hakkında ayrıntılı bilgi için aşağıdaki makalelere bakın.
Hakkında bilgi için | Bkz: |
---|---|
Kullanılacak derleyici seçenekleri | /doc |
Belgelerde yaygın olarak kullanılan işlevleri sağlamak için kullanabileceğiniz etiketler | Belge açıklamaları için önerilen etiketler |
Derleyicinin kodunuzdaki yapıları tanımlamak için ürettiği kimlik dizeleri | XML Dosyasını İşleme |
Belge etiketlerini sınırlandırma | Visual C++ belge etiketleri için sınırlayıcılar |
Bir veya daha fazla XDC dosyasından XML dosyası oluşturma. | XDCMake başvurusu |
Visual Studio özellik alanlarıyla ilgili XML hakkındaki bilgilere bağlantılar | Visual Studio'da XML |
Belge açıklamasının metnine XML özel karakterleri yerleştirmeniz gerekiyorsa, XML varlıklarını veya CDATA bölümünü kullanmanız gerekir.