Sınırlayıcılar belgelerine etiketleri (C# Programlama Kılavuzu)

Belgelere açıklama nerede başladığını ve bittiğini derleyici belirtin sınırlayıcılar xml Belge açıklamaları kullanılmasını gerektirir. xml belgeleri etiketlerle aşağıdaki sınırlayıcı türlerini kullanabilirsiniz:

• ///
  Tek satırlı sınırlayıcısı. Bu belgeleri örneklerde gösterildiği ve Visual C# Proje Şablonları tarafından kullanılan formdur. Sınırlayıcı izleyen boşluk karakteri ise, o karakter xml çıktısına dahil edilmez.

  Not

  Visual Studio IDE Akıllı yorum <summary> otomatik olarak eklediği düzenleme adında bir özelliğe sahiptir. ve </summary> etiketler ve yazdıktan sonra bu etiketleri içinde imleci hareket /// Code Editor içinde sınırlayıcı.Bu özelliğinden erişim Seçenekleri, metin düzenleyicisi, C# biçimlendirme, project özellik sayfalarında.

• /** */
  Çok satırlı sınırlayıcı.

Kullandığınızda izlemeniz bazı biçimlendirme kuralları vardır /** */ sınırlayıcı.

• İçeren satırdaki /** beyaz boşluk, satır satır geri kalanı ise, sınırlayıcı yorumlar işlenmez. Sonra ilk karakteri /** sınırlayıcı olan beyaz boşluk, boşluk karakteri göz ardı edilir ve satırın kalanını işlenir. Aksi halde, tüm satırın metnini /** sınırlayıcı yorum bir parçası olarak işlenir.

• İçeren satırdaki */ , yoksa yalnızca boşluk kadar sınırlayıcı */ sınırlayıcı, o satırı göz ardı edilir. Aksi takdirde, en fazla satırındaki metin */ sınırlayıcı yorum, desen eşleştirme kuralları aşağıdaki madde açıklanan tabi bir parçası olarak işlenir.

• İle başlayan bir sonra satırlar için /** sınırlayıcı, derleyici her satırın başına ortak bir desene arama yapar. Desen isteğe bağlı beyaz boşluk ve yıldız oluşabilir (*) ve ardından daha fazla isteğe bağlı beyaz boşluk. Derleyici ile başlamayan her satırın başında ortak bir modele bulursa /** sınırlayıcı veya */ sınırlayıcı, her satır için o desen yok sayar.

Bu kurallar aşağıdaki örneklerde gösterilmektedir.

• İle başlayan satırın işlenecek aşağıdaki açıklamayı sadece bir bölümünü ise <summary>. Üç etiket biçimleri aynı yorumları üretir.

  /** <summary>text</summary> */ 
  
  /** 
  <summary>text</summary> 
  */ 
  
  /** 
   * <summary>text</summary> 
  */ 
  

• Derleyici, ortak bir desen tanımlar "*" ikinci ve üçüncü satır başında. Desen çıktıda bulunmaz.

  /** 
   * <summary> 
   * text </summary>*/ 
  

• Üçüncü satır ikinci karakteri yıldız olmadığı için derleyici aşağıdaki açıklamada ortak bir desen bulur. Bu nedenle, tüm metin ikinci ve üçüncü satırlarındaki Açıklama bir parçası olarak işlenir.

  /** 
   * <summary> 
     text </summary>
  */ 
  

• Derleyici hiçbir desen aşağıdaki açıklamada iki nedenden bulur. İlk olarak, yıldız önce boşluk sayısını tutarlı değil. İkinci olarak, beşinci satır boşluk eşleşmeyen bir sekme ile başlar. Bu nedenle, tüm metin satırlarından iki ile beş açıklamanın bir bölümü işlenir.

  /** 
    * <summary> 
    * text 
   *  text2 
      *  </summary> 
  */ 
  

Ayrıca bkz.

Başvuru

xml belgesi açıklamalarının (C# Programlama Kılavuzu)

/doc (C# Derleyici Seçenekleri)

xml belgesi açıklamalarının (C# Programlama Kılavuzu)

Kavramlar

C# Programlama Kılavuzu