Jos haluat lisätä viitteenkommentteja omaan XML-koodi, käytä tätä vaiheittaista opetusohjelmaa. Voit oppia tämän toiminnon suorittamisen vain viidessä minuutissa. Vaikka prosessi on helppo suorittaa, sinun on silti tiedettävä joitain perusteita XML-kommenteista ja niiden hyödyllisyydestä ennen aloittamista.
Miksi XML-kommentit ovat hyödyllisiä?
XML: n kommentit ovat lähes identtisiä HTML: n kommenttien kanssa, koska molemmilla on sama syntakse. Kommenttien käyttäminen avulla voit ymmärtää vuosia aiemmin kirjoittamasi koodin. Se voi myös auttaa toista kehittäjää, joka tarkistaa kehittämäsi koodin, ymmärtämään kirjoittamasi. Lyhyesti sanottuna nämä kommentit tarjoavat kontekstin koodille.
Kommenteilla voit helposti jättää muistiinpanon tai poistaa väliaikaisesti osan XML-koodista. Vaikka XML on suunniteltu "itse kuvaavaksi tiedoksi", saatat joutua joskus jättämään XML-kommentin.
Päästä alkuun
Kommenttimerkit koostuvat kahdesta osasta: kommentin aloittavasta ja sen päättävästä osasta. Aloita lisäämällä kommenttikoodin ensimmäinen osa:
Kirjoita sitten haluamasi kommentti. Varmista vain, että et sijoita kommentteja muihin kommentteihin (katso vinkkejä lisätietoja). Sen jälkeen suljet kommenttitagin:
-->
Hyödyllisiä vinkkejä
Kun lisäät referenssikommentteja XML-koodiin, muista, että ne eivät voi olla asiakirjan yläosassa. XML: ssä vain XML-ilmoitus voi tulla ensin:
Kuten edellä mainittiin, kommentteja ei välttämättä ole sisäkkäin. Sinun on suljettava ensimmäinen kommenttisi ennen kuin avaat toisen. Kommentteja ei myöskään voi esiintyä tageissa, esim.
.
Älä koskaan käytä kahta viivaa (-) muualla kuin kommenttien alussa ja lopussa. Mikä tahansa kommenteissa näkyvä on XML-jäsennin, joten ole erittäin varovainen, että mikä on jäljellä, on edelleen pätevä ja hyvin muotoiltu.
Käärimistä
Jos sinulla on vielä kysyttävää referenssikommenttien lisäämisestä XML-koodiin, sinun kannattaa ehkä lukea kirja, jotta saat yksityiskohtaisen kuvan prosessin toiminnasta. Kirjat, kutenRod Stephensin "C # 5.0 -ohjelmoijan viite" voi osoittautua hyödylliseksi.