-doc

  • Makale

Belge açıklamalarını bir XML dosyasına işler.

Sözdizimi

-doc[+ | -]

veya

-doc:file

Bağımsız değişkenler

Süre Tanım
+ | - isteğe bağlı. +veya yalnızca -docdeğerinin belirtilmesi, derleyicinin belge bilgileri oluşturmasına ve bir XML dosyasına yerleştirmesine neden olur. - belirtme, belirtilmemesiyle -doceşdeğerdir ve hiçbir belge bilgisi oluşturulmamasına neden olur.
file Kullanılıyorsa -doc: gereklidir. Derlemenin kaynak kodu dosyalarındaki açıklamalarla doldurulan çıktı XML dosyasını belirtir. Dosya adında boşluk varsa, adı tırnak işaretleri (" ") ile çevreleyin.

Açıklamalar

seçeneği, -doc derleyicinin belge açıklamalarını içeren bir XML dosyası oluşturup oluşturmadığını denetler. Söz dizimini -doc:file kullanırsanız, file parametresi XML dosyasının adını belirtir. veya -doc+kullanıyorsanız-doc, derleyici, derleyicinin oluşturduğu yürütülebilir dosya veya kitaplıktan XML dosya adını alır. Seçeneğini kullanır -doc- veya belirtmezseniz -doc , derleyici bir XML dosyası oluşturmaz.

Kaynak kodu dosyalarında, belge açıklamaları aşağıdaki tanımlardan önce gelebilir:

Oluşturulan XML dosyasını Visual Studio IntelliSense özelliğiyle kullanmak için, XML dosyasının dosya adının desteklemek istediğiniz derlemeyle aynı olmasına izin verin. Visual Studio projesinde derlemeye başvurulduğunda .xml dosyasının da bulunması için XML dosyasının derlemeyle aynı dizinde olduğundan emin olun. IntelliSense'in bir proje içinde veya bir proje tarafından başvuruda yer alan projelerde kod için çalışması için XML belge dosyaları gerekli değildir.

ile -target:modulederlemediğiniz sürece, XML dosyası etiketlerini <assembly></assembly>içerir. Bu etiketler, derlemenin çıkış dosyası için derleme bildirimini içeren dosyanın adını belirtir.

Kodunuzdaki açıklamalardan belge oluşturmanın yolları için bkz . XML Açıklama Etiketleri .

Visual Studio tümleşik geliştirme ortamında -doc'ı ayarlamak için
1. Çözüm Gezgini'de bir projenin seçilmesini sağlayın. Proje menüsünde Özellikler'e tıklayın.
2. Derle sekmesine tıklayın.
3. XML belgeleri dosyası oluştur kutusunda değeri ayarlayın.

Örnek

Örnek için bkz . Kodunuzu XML ile Belgeleme.

Ayrıca bkz.