Sisällysluettelo:

Kuinka lisään kommentteja XML:ään Visual Studiossa?
Kuinka lisään kommentteja XML:ään Visual Studiossa?

Video: Kuinka lisään kommentteja XML:ään Visual Studiossa?

Video: Kuinka lisään kommentteja XML:ään Visual Studiossa?
Video: CS50 2013 - Week 9 2024, Saattaa
Anonim

XML-kommenttien lisääminen koodielementille

  1. Kirjoita /// C#:lla tai '''' sisään Visual Basic .
  2. Valitse Muokkaa-valikosta IntelliSense > Lisää kommentti .
  3. Valitse koodielementin päällä tai yläpuolella olevasta hiiren kakkospainikkeella tai kontekstivalikosta Snippet > Lisää kommentti .

Lisäksi, kuinka kirjoitan kommentteja XML-muodossa?

Jos haluat kommentti yhdellä rivillä XML koodi, aseta kohdistin haluamasi rivin alkuun kommentti ulos. Kirjoita pienempi kuin -symboli, jota seuraa huutomerkki ja kaksi viivaa. Siirrä kohdistin rivin loppuun ja kirjoita sitten kaksi viivaa ja sen jälkeen suurempi kuin -symboli.

Voidaan myös kysyä, kuinka kommentoin koodia C#:lla? Vastaanottaja koodi a kommentti , kirjoita kaksinkertainen vinoviiva ja sen jälkeen kommentti . Voit käyttää tätä tekniikkaa lisätäksesi a kommentti omalla rivillään tai lisätäksesi a kommentti jälkeen koodi linjalla. Usein kun sinä koodi , saatat haluta kommentti pois kokonaisen korttelin koodi lausunnot.

Toiseksi, mitä ovat XML-kommentit C#:ssa?

Yksi näistä on XML Dokumentointi kommentteja , joskus kutsutaan XML-kommentit , joka alkaa kolminkertaisella kauttaviivalla - ///. XML-kommentit voidaan käyttää Visual Studion ja VS Coden IntelliSense-ominaisuuden avulla näyttämään tietoja tyypistä tai jäsenestä; nämä tiedot tulevat siitä, mitä olet lisännyt koodidokumentaatioon.

Miten dokumentoit koodin?

Parhaat käytännöt dokumentaation kirjoittamiseen:

  1. Sisällytä README-tiedosto, joka sisältää.
  2. Salli ongelmanseuranta muille.
  3. Kirjoita API-dokumentaatio.
  4. Dokumentoi koodisi.
  5. Käytä koodauskäytäntöjä, kuten tiedostojen järjestämistä, kommentteja, nimeämiskäytäntöjä, ohjelmointikäytäntöjä jne.
  6. Sisällytä tiedot osallistujille.

Suositeltava: