Mundarija:

Visual Studio'da XML ga qanday izoh qo'shishim mumkin?
Visual Studio'da XML ga qanday izoh qo'shishim mumkin?

Video: Visual Studio'da XML ga qanday izoh qo'shishim mumkin?

Video: Visual Studio'da XML ga qanday izoh qo'shishim mumkin?
Video: Использование карты Micro SD и регистрация данных с помощью Arduino | Пошаговый курс Arduino, урок 106 2024, Noyabr
Anonim

Kod elementi uchun XML sharhlarini kiritish uchun

  1. C# da /// yoki ''' yozing Visual Basic .
  2. Tahrirlash menyusidan IntelliSense > ni tanlang Izoh kiritish .
  3. Sichqonchaning o'ng tugmasi yoki kontekst menyusidan kod elementi ustida yoki faqat yuqorisida, Snippet > ni tanlang Izoh kiritish .

Bundan tashqari, XML-da sharhlarni qanday yozaman?

Agar xohlasang izoh ichida bitta qatorni chiqaring XML Kod, kursorni kerakli qatorning boshiga qo'ying izoh tashqariga. Undan keyin undov belgisi va ikkita chiziqchadan kichikroq belgini kiriting. Kursorni chiziq oxiriga olib boring va keyin ikkita chiziqcha va undan keyin kattaroq belgini kiriting.

Bundan tashqari, C# da kodni qanday izohlashim mumkin? Kimga kod a izoh , ikkita oldinga qiyshiq chiziqdan keyin yozing izoh . A qo'shish uchun ushbu texnikadan foydalanishingiz mumkin izoh o'z satrida yoki a qo'shish uchun izoh keyin kod chiziq ustida. Ko'pincha qachon kod , xohlashingiz mumkin izoh butun blokdan tashqariga chiqdi kod bayonotlar.

Ikkinchidan, C# da XML sharhlari nima?

Shulardan biri XML Hujjatlar Izohlar , ba'zan chaqiriladi XML sharhlari , uch qiyshiq chiziq bilan boshlanadi - ///. XML sharhlari turi yoki a'zosi haqidagi ma'lumotlarni ko'rsatish uchun Visual Studio va VS kodining IntelliSense xususiyatidan foydalanish mumkin; bu ma'lumot kod hujjatlariga kiritgan narsangizdan kelib chiqadi.

Kodni qanday hujjatlashtirasiz?

Hujjatlarni yozish uchun eng yaxshi amaliyotlar:

  1. O'z ichiga olgan README faylini qo'shing.
  2. Boshqalar uchun muammo kuzatuvchisiga ruxsat bering.
  3. API hujjatlarini yozing.
  4. Kodingizni hujjatlashtiring.
  5. Fayllarni tashkil qilish, sharhlar, nomlash qoidalari, dasturlash amaliyoti va boshqalar kabi kodlash qoidalarini qo'llang.
  6. Ishtirokchilar uchun ma'lumotni qo'shing.

Tavsiya: