INHOUDSOPGAWE:

Hoe voeg ek opmerkings by XML in Visual Studio?
Hoe voeg ek opmerkings by XML in Visual Studio?

Video: Hoe voeg ek opmerkings by XML in Visual Studio?

Video: Hoe voeg ek opmerkings by XML in Visual Studio?
Video: Gregory Chaitin: Complexity, Metabiology, Gödel, Cold Fusion 2024, November
Anonim

Om XML-kommentaar vir 'n kode-element in te voeg

  1. Tik /// in C#, of ''' in Visual Basic .
  2. Kies IntelliSense > in die Wysig-kieslys Voeg opmerking in .
  3. Kies Brokkie > uit die regskliek of kontekskieslys op of net bokant die kode-element Voeg opmerking in .

Verder, hoe skryf ek opmerkings in XML?

As jy wil kommentaar lewer uit 'n enkele reël in die XML kode, plaas jou wyser aan die begin van 'n reël wat jy wil kommentaar lewer uit. Tik 'n minder-as-simbool gevolg deur 'n uitroepteken en twee strepies. Beweeg jou wyser na die einde van die reël en tik dan twee strepies gevolg deur 'n groter-as-simbool.

Mens kan ook vra, hoe lewer ek kommentaar op kode in C#? Om kode a kommentaar lewer , tik 'n dubbel vorentoe skuinsstreep gevolg deur die kommentaar lewer . Jy kan hierdie tegniek gebruik om 'n by te voeg kommentaar lewer op sy eie lyn of om 'n by te voeg kommentaar lewer na die kode op 'n lyn. Dikwels wanneer jy kode , wil jy dalk kommentaar lewer 'n hele blok uit kode stellings.

Tweedens, wat is XML-opmerkings in C#?

Een hiervan is XML Dokumentasie kommentaar , soms genoem XML opmerkings , wat begin met 'n driedubbele skuinsstreep - ///. XML opmerkings kan deur die IntelliSense-kenmerk van Visual Studio en VS-kode gebruik word om inligting oor 'n tipe of lid te wys; hierdie inligting kom van wat jy in jou kode dokumentasie plaas.

Hoe dokumenteer jy kode?

Beste praktyke vir die skryf van dokumentasie:

  1. Sluit 'n README-lêer in wat bevat.
  2. Laat kwessiespoorder vir ander toe.
  3. Skryf 'n API-dokumentasie.
  4. Dokumenteer jou kode.
  5. Pas koderingskonvensies toe, soos lêerorganisasie, opmerkings, naamkonvensies, programmeringspraktyke, ens.
  6. Sluit inligting vir bydraers in.

Aanbeveel: