Skip to main content

Lägg till referens kommentarer till din XML-kod

Things Mr. Welch is No Longer Allowed to do in a RPG #1-2450 Reading Compilation (April 2025)

Things Mr. Welch is No Longer Allowed to do in a RPG #1-2450 Reading Compilation (April 2025)
Anonim

Om du är intresserad av att lägga till referens kommentarer till din XML-kod, använd denna steg-för-steg-handledning för vägledning. Du kan lära dig att utföra denna funktion på bara fem minuter. Medan processen är lätt att slutföra, borde du fortfarande veta några grunder om XML-kommentarer och deras användbarhet innan du börjar.

Varför XML-kommentarer är användbara

Kommentarer i XML är nästan identiska med kommentarer i HTML, eftersom de båda har samma syntax. Med hjälp av kommentarer kan du förstå kod du skrev år tidigare. Det kan också hjälpa en annan utvecklare som granskar koden du utvecklade för att förstå vad du skrev. Kort sagt, dessa kommentarer ger sammanhang för koden.

Med kommentarer kan du enkelt lämna en anteckning eller tillfälligt ta bort en del av en XML-kod. Även om XML är utformat för att vara "självbeskrivande data", kan du ibland behöva lämna en XML-kommentar.

Komma igång

Kommentar taggar består av två delar: den del som börjar kommentaren och delen slutar den. För att börja, lägg till den första delen av kommentartecken

Användbara tips

När du lägger till referens kommentarer till din XML-kod, kom ihåg att de inte kan komma längst upp i dokumentet. I XML kan endast XML-deklarationen komma först:

Som nämnts ovan kan kommentarer inte nästas inuti en annan. Du måste stänga din första kommentar innan du öppnar en sekund. Också kommentarer kan inte förekomma inom taggar, t.ex.

.

Använd aldrig de två streckknapparna (-) någonstans men i början och slutet av dina kommentarer. Något i kommentarer är effektivt osynligt för XML-parsern, var därför mycket försiktig med att det som återstår är fortfarande giltigt och välformat.

Avslutar

Om du fortfarande har frågor om att lägga till referens kommentarer till XML-kod kanske du vill läsa en bok för att ge dig en detaljerad bild av hur processen fungerar. Böcker som "C # 5.0 Programmerarens referens" av Rod Stephens kan vara till hjälp.