Aracılığıyla paylaş


Visual C++ Belge Etiketleri için Sınırlayıcılar

Derleyiciye belgelere açıklama nerede başladığını ve bittiğini gösteren sınırlayıcıları belgelerine etiketler gerektirir.

xml belgeleri etiketlerle sınırlayıcılar aşağıdaki türlerini kullanabilirsiniz:

  • ///
    Bu belgeleri örneklerde gösterildiği ve Visual c++ proje şablonları tarafından kullanılan formdur.

  • /** */
    Bunlar çok satırlı sınırlayıcı olarak kullanılır.

Bazı biçimlendirme kuralları kullanırken vardır /** */ sınırlayıcı:

  • İçeren satırı için /** ayırıcı satırın kalan satır boşluğu ise, yorumlar için işlenmemiş.İlk karakter boşluk ise, o boşluk karakteri dikkate alınmaz ve satırın geri kalan işlenir.Aksi halde, tüm satırın metnini /** sınırlayıcı bir açıklamanın parçası olarak işlenir.

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

  • Sonra biri ile başlayan satırlar için /** sınırlayıcı, derleyici arar, isteğe bağlı beyaz boşluk ve yıldız oluşan her satırın başında ortak bir desen (*) ardından daha fazla isteğe bağlı beyaz boşluk.Derleyici her satırın başında ortak bir karakter kümesi bulursa, bu desen sonra tüm satırları dikkate almaz /** kadar ve belki de dahil olmak üzere içeren satırı sınırlayıcı */ sınırlayıcısı.

Bazı örnekler:

  • İle başlayan satır işlenecek aşağıdaki açıklamayı tek parçası olan <summary>.Aşağıdaki iki etiket biçimlerini aynı yorumları üretecektir:

    /**
    <summary>text</summary> 
    */
    /** <summary>text</summary> */
    
  • Derleyici, bir desen uygular "*", ikinci ve üçüncü satır başında yoksaymak için.

    /**
     * <summary>
     *  text </summary>*/
    
  • İkinci satırda hiçbir yıldız çünkü derleyici bu açıklamada hiçbir desen bulur.Bu nedenle, ikinci ve üçüncü satırlarındaki tüm metni yukarı kasa */, açıklamanın parçası olarak işlenir.

    /**
     * <summary>
       text </summary>*/
    
  • Derleyici, iki nedenden dolayı bu açıklamada hiçbir desen bulur.İlk olarak, tutarlı bir dizi yıldız işareti önce boşluk ile başlayan hiçbir satır vardır.İkinci olarak, beşinci satır boşluk eşleşmeyen bir sekme ile başlar.Bu nedenle, ikinci satıra kadar tüm metinden */ açıklamanın parçası olarak işlenir.

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

Ayrıca bkz.

Diğer Kaynaklar

XML Belgeleri (Visual C++)