Om du är intresserad av att lägga till referenskommentarer till din XML-kod, använd den här steg-för-steg-handledningen för vägledning. Du kan lära dig att utföra denna funktion på bara fem minuter. Även om processen är lätt att slutföra bör du fortfarande känna till 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. Använda kommentarer låter dig förstå koden du skrev år tidigare. Det kan också hjälpa en annan utvecklare som granskar koden du utvecklat för att förstå vad du skrev. Kort sagt, dessa kommentarer ger kontext 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
Kommentartaggar består av två delar: delen som startar kommentaren och delen som avslutar den. För att börja, lägg till den första delen av kommentartaggen:
Skriv sedan vilken kommentar du vill. Se bara till att du inte hyser kommentarer i andra kommentarer (se tips för mer information). Därefter stänger du kommentarstaggen:
-->
Användbara tips
När du lägger till referenskommentarer till din XML-kod, kom ihåg att de inte kan komma högst upp i ditt dokument. I XML kan bara XML-deklarationen komma först:
Som nämnts ovan kanske kommentarer inte är kapslade i varandra. Du måste stänga din första kommentar innan du öppnar en andra. Kommentarer kan inte heller förekomma inom taggar, t.ex.
.
Använd aldrig de två streckarna (-) någon annanstans än i början och slutet av dina kommentarer. Allt i kommentarer är effektivt osynligt för XML-analysator, så var mycket försiktig med att det som återstår fortfarande är giltigt och välformat.
Avslutar
Om du fortfarande har frågor om hur du lägger till referenskommentarer 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 Programmerarreferens" av Rod Stephens kan vara till hjälp.