XML Belgeleri (Visual C++)
Visual C++'da, bir .xml dosyası işlenmiş kaynak kodu için yorum ekleyebilirsiniz. Bu dosya daha sonra giriş sınıfları için belgeleri kodunuzda oluşturduğu bir işlem olabilir.
Visual c++ kod dosyasında bir xml belgeleme yorumlarını doğrudan bir yöntem veya türü tanımı önce yer alması gerekir. Açıklamalar aşağıdaki senaryolarda IntelliSense Hızlı bilgi veri ipucu doldurmak için kullanılabilir:
ne zaman kod Windows çalışma zamanı bileşeni olarak eşlik eden bir .winmd dosyası ile derlenir
Geçerli projede kaynak kodu ne zaman dahil edilir
bir kitaplıkta, tür bildirimleri ve uygulamaları aynı üstbilgi dosyasında bulunur
Not
Geçerli sürümde, şablonlar veya bir şablon türü (örneğin, bir parametre olarak bir şablon alma bir işlev) içeren kod açıklamaları işlenmez.Bu tür açıklamalar ekleme tanımsız davranışlara neden olur.
Belge açıklamaları bir .xml dosyası oluşturma hakkında ayrıntılı bilgi için aşağıdaki konulara bakın.
Hakkında bilgi için |
Daha fazla bilgi için bkz: |
|---|---|
Kullanılacak derleyici seçenekleri |
|
Etiketler genellikle sağlamak için kullanabileceğiniz işlevselliği belgelerinde kullanılan |
|
Derleyici kodunuzda yapılarını tanımlamak için üreten kimliği dizesi |
|
Nasıl belgelerine etiketler sınırlandırmak |
|
Bir veya daha fazla .xdc dosyalarından bir .xml dosyası oluşturuluyor. |
|
Visual Studio özellik alanları için xml hakkında bilgilere bağlantılar ilişkilendirir |
xml özel karakterleri belgelere açıklama metninde koymak gerekiyorsa, xml varlıkları veya cdata bölümü kullanmanız gerekir.