Sisukord:

Kuidas lisada Visual Studios XML-i kommentaare?
Kuidas lisada Visual Studios XML-i kommentaare?

Video: Kuidas lisada Visual Studios XML-i kommentaare?

Video: Kuidas lisada Visual Studios XML-i kommentaare?
Video: Полный курс React JS для начинающих - Изучи Реакт за 2 часа! +таймкоды 2024, Detsember
Anonim

Koodielemendi XML-i kommentaaride sisestamiseks

  1. Sisestage /// C#-s või '''' Visual Basic .
  2. Valige menüüst Redigeerimine IntelliSense > Sisesta kommentaar .
  3. Paremklõpsake või kontekstimenüüst koodielemendil või selle kohal valige Snippet > Sisesta kommentaar .

Lisaks, kuidas kirjutada kommentaare XML-vormingus?

Kui sa tahad kommenteerida välja ühe rea XML kood, sisestage kursor soovitud rea algusesse kommenteerida välja. Sisestage väiksem kui sümbol, millele järgneb hüüumärk ja kaks kriipsu. Liigutage kursor rea lõppu ja sisestage kaks kriipsu, millele järgneb sümbol suurem kui.

Võib ka küsida, kuidas ma C#-s koodi kommenteerin? To kood a kommenteerida , tippige topelt kaldkriips, millele järgneb kommenteerida . Seda tehnikat saate kasutada a kommenteerida omal real või lisada a kommenteerida pärast kood joonel. Sageli, kui sa kood , võite soovida kommenteerida terve kvartali välja kood avaldused.

Teiseks, mis on XML-i kommentaarid C#-s?

Üks neist on XML Dokumentatsioon kommentaarid , mõnikord nimetatakse XML-kommentaarid , mis algab kolmekordse kaldkriipsuga - ///. XML-kommentaarid saab kasutada Visual Studio ja VS Code'i funktsioon IntelliSense, et kuvada teavet tüübi või liikme kohta; see teave pärineb sellest, mida sisestasite oma koodi dokumentatsiooni.

Kuidas koodi dokumenteerite?

Dokumentatsiooni kirjutamise parimad tavad:

  1. Kaasake README-fail, mis sisaldab.
  2. Luba probleemijälgija teistele.
  3. Kirjutage API dokumentatsioon.
  4. Dokumenteerige oma kood.
  5. Rakendage kodeerimistavasid, nagu failikorraldus, kommentaarid, nimetamistavad, programmeerimistavad jne.
  6. Kaasake teave kaastöölistele.

Soovitan: