Hoe om referentiekommentaar by jou XML-kode te voeg

Kry die feite met hierdie stap-vir-stap-gids

As jy belangstel om verwysingsopmerkings by jou XML-kode te voeg, gebruik hierdie stap-vir-stap handleiding vir leiding. U kan leer hoe om hierdie funksie in net vyf minute uit te voer. Alhoewel die proses maklik is om te voltooi, moet jy steeds basiese kennis oor XML-kommentaar en hul nut weet voordat jy begin.

Hoekom XML-kommentaar is nuttig

Kommentaar in XML is byna identies aan opmerkings in HTML, aangesien hulle albei dieselfde sintaksis het. Deur kommentaar te gebruik, kan jy die kode wat jy jare voorheen geskryf het, verstaan. Dit kan ook help met 'n ander ontwikkelaar wat die kode hersien wat jy ontwikkel het, en verstaan ​​wat jy geskryf het. Kortom, hierdie kommentaar verskaf konteks vir die kode.

Met kommentaar kan jy maklik 'n nota los of 'n deel van 'n XML-kode tydelik verwyder. Alhoewel XML ontwerp is om "selfbeskrywing van data" te wees, moet jy dalk 'n XML-kommentaar verlaat.

Aan die gang kom

Kommentaar etikette bestaan ​​uit twee dele: die deel wat die kommentaar begin en die deel wat dit eindig. Om te begin, voeg die eerste deel van die kommentaar tag enige kommentaar wat jy wil hê. Maak net seker dat jy nie kommentaar in ander kommentaar neersit nie (sien wenke vir meer besonderhede).

Daarna sluit jy die kommentaar tag ->

Nuttige wenke

As jy verwysingsopmerkings by jou XML-kode voeg, onthou dat hulle nie bo-aan jou dokument kan kom nie. In XML kan slegs die XML-verklaring eerste wees:

Soos hierbo genoem, kan kommentaar nie een in die ander geneste wees nie. U moet u eerste opmerking sluit voordat u 'n tweede oopmaak. Ook kan kommentaar nie binne tags voorkom nie, bv. .

Moet nooit die twee stippies (-) gebruik nie, maar aan die begin en einde van u kommentaar. Enigiets in kommentaar is effektief onsigbaar vir die XML-parser. Wees dus baie versigtig dat dit nog steeds geldig en goed gevorm is.

Klaar maak

As u nog vrae het oor die byvoeg van verwysings opmerkings na XML-kode, wil u dalk 'n boek lees om u 'n gedetailleerde prentjie te gee van hoe die proses werk. Boeke soos C # 5.0 Programmer se verwysing deur Rod Stephens kan nuttig wees. Gaan aanlyn-kleinhandelaars of u plaaslike biblioteek vir soortgelyke boeke na.