Aracılığıyla paylaş

Belge kuralları

  • Makale

Belge kuralları, dışarıdan görünen API'ler için XML belge açıklamalarının doğru kullanımı aracılığıyla iyi belgelenmiş kitaplıklar yazmayı destekler.

Bu bölümde

Kural Açıklama
CA1200: cref etiketlerini ön ek ile kullanmaktan kaçının XML belge etiketindeki cref özniteliği "kod başvurusu" anlamına gelir. Etiketin iç metninin tür, yöntem veya özellik gibi bir kod öğesi olduğunu belirtir. Derleyicinin başvuruları doğrulamasını engellediğinden, ön ekleri olan etiketleri kullanmaktan cref kaçının. Ayrıca yeniden düzenleme sırasında Visual Studio tümleşik geliştirme ortamının (IDE) bu sembol başvurularını bulmasını ve güncelleştirmesini engeller.