Kodunuzu XML ile belgele (Visual Basic)

  • Makale

Visual Basic'te XML kullanarak kodunuzu belgeleyebilirsiniz.

XML belgeleri yorumları

Visual Basic, projeler için xml belgelerini otomatik olarak oluşturmak için kolay bir yol sağlar. Türleriniz ve üyeleriniz için otomatik olarak bir XML iskeleti oluşturabilir ve ardından her parametre için özetler, açıklayıcı belgeler ve diğer açıklamalar sağlayabilirsiniz. Uygun kurulumla, XML belgeleri projenizle aynı kök dosya adına sahip bir XML dosyasına otomatik olarak gönderilir. XML belge dosyasının oluşturulmasını yapılandırma hakkında bilgi için bkz . -doc derleyici seçeneği ve GenerateDocumentationFile MSBuild özelliği.

XML dosyası xml olarak kullanılabilir veya başka bir şekilde değiştirilebilir. Bu dosya, projenizin çıkış .exe veya .dll dosyasıyla aynı dizinde bulunur.

XML belgeleri ile '''başlar. Bu açıklamaların işlenmesinde bazı kısıtlamalar vardır:

  • Belgeler iyi biçimlendirilmiş XML olmalıdır. XML düzgün biçimlendirilmemişse bir uyarı oluşturulur ve belge dosyasında hatayla karşılaşıldığını belirten bir açıklama bulunur.

  • Geliştiriciler kendi etiket kümelerini oluşturabilir. Önerilen bir etiket kümesi vardır (bkz. XML Açıklama Etiketleri). Önerilen etiketlerden bazılarının özel anlamları vardır:

    • <parametre> etiketi, parametreleri açıklamak için kullanılır. Kullanılırsa, derleyici parametrenin mevcut olduğunu ve tüm parametrelerin belgelerde açıklandığını doğrular. Doğrulama başarısız olursa, derleyici bir uyarı görüntüler.

    • Özniteliği cref , bir kod öğesine başvuru sağlamak için herhangi bir etikete eklenebilir. Derleyici bu kod öğesinin mevcut olduğunu doğrular. Doğrulama başarısız olursa, derleyici bir uyarı görüntüler. Derleyici ayrıca özniteliğinde açıklanan bir türü ararken tüm Imports deyimlere de saygı gösterir cref .

    • Özet <> etiketi, Visual Studio'daki IntelliSense tarafından bir tür veya üye hakkında ek bilgi görüntülemek için kullanılır.

Belge açıklamaları içeren bir XML dosyası oluşturma hakkında ayrıntılı bilgi için aşağıdaki konulara bakın:

Ayrıca bkz.