Mündəricat:

Visual Studio-da XML-ə şərhləri necə əlavə edə bilərəm?
Visual Studio-da XML-ə şərhləri necə əlavə edə bilərəm?

Video: Visual Studio-da XML-ə şərhləri necə əlavə edə bilərəm?

Video: Visual Studio-da XML-ə şərhləri necə əlavə edə bilərəm?
Video: Добро пожаловать в Visual Studio 2022 - Скотт Хансельман и его друзья 2024, Noyabr
Anonim

Kod elementi üçün XML şərhləri daxil etmək üçün

  1. C# dilində /// və ya ''' yazın Visual Basic .
  2. Redaktə menyusundan IntelliSense > seçin Şərh daxil edin .
  3. Kod elementinin üzərində və ya onun üstündəki sağ klik və ya kontekst menyusundan Snippet > seçin Şərh daxil edin .

Üstəlik, şərhləri XML-də necə yaza bilərəm?

İstəsən Şərh içərisində bir sətir çıxır XML kodu, kursorunuzu istədiyiniz xəttin əvvəlinə daxil edin Şərh həyata. Daha kiçik simvolu, ardınca nida işarəsi və iki tire yazın. Kursoru xəttin sonuna aparın və sonra iki tire və ardınca böyük simvolu yazın.

Kimsə soruşa bilər ki, mən C#-da kodu necə şərh edə bilərəm? Kimə kod a Şərh , ardınca ikiqat əyri xətt yazın Şərh . Əlavə etmək üçün bu texnikadan istifadə edə bilərsiniz Şərh öz xəttində və ya əlavə etmək üçün a Şərh sonra kod bir xətt üzərində. Çox vaxt sən kod , istəyə bilərsiniz Şərh bütöv bir blokdan kod bəyanatlar.

İkincisi, C#-da XML şərhləri nədir?

Bunlardan biri XML Sənədlər şərhlər , bəzən çağırılır XML şərhləri , üçqat kəsiklə başlayan - ///. XML şərhləri növ və ya üzv haqqında məlumatı göstərmək üçün Visual Studio və VS Kodunun IntelliSense xüsusiyyətindən istifadə edilə bilər; bu məlumat kod sənədlərinizə qoyduğunuzdan gəlir.

Kodu necə sənədləşdirirsiniz?

Sənədlərin yazılması üçün ən yaxşı təcrübələr:

  1. Tərkibində olan README faylını daxil edin.
  2. Başqaları üçün problem izləyicisinə icazə verin.
  3. API sənədlərini yazın.
  4. Kodunuzu sənədləşdirin.
  5. Fayl təşkili, şərhlər, adlandırma konvensiyaları, proqramlaşdırma təcrübələri və s. kimi kodlaşdırma konvensiyalarını tətbiq edin.
  6. Əmanətçilər üçün məlumat daxil edin.

Tövsiyə: