Pokud máte zájem přidat do svého referenčního komentáře XML kód, použijte jako návod tento podrobný návod. Jak se tato funkce provede, se naučíte za pouhých pět minut. I když je proces snadné dokončit, měli byste ještě před zahájením vědět nějaké základní informace o komentářích XML a jejich užitečnosti.
Proč jsou XML komentáře užitečné
Komentáře v XML jsou téměř identické s komentáři v HTML, protože oba mají stejnou syntaxi. Používání komentářů vám umožní porozumět kódu, který jste napsali před lety. Může také pomoci jinému vývojáři, který kontroluje kód, který jste vyvinuli, aby pochopil, co jste napsali. Stručně řečeno, tyto komentáře poskytují kontext kódu.
S komentáři můžete snadno zanechat poznámku nebo dočasně odebrat část kódu XML. Přestože je XML navrženo jako „data s vlastním popisem“, občas budete možná muset zanechat komentář XML.
Začínáme
Značky komentářů se skládají ze dvou částí: části začínající komentář a části končící komentář. Začněte tím, že přidáte první část značky komentáře:
Poté napište jakýkoli komentář, který chcete. Nezapomeňte vnořit komentáře do jiných komentářů (další tipy najdete v tipech). Poté zavřete značku komentáře:
-->
Užitečné tipy
Při přidávání referenčních komentářů do kódu XML nezapomeňte, že se nemohou nacházet na samém vrcholu dokumentu. V XML může být na prvním místě pouze deklarace XML:
Jak bylo uvedeno výše, komentáře nemusí být vnořeny jeden do druhého. Než otevřete druhý, musíte zavřít svůj první komentář. Ve značkách se také nemohou vyskytovat komentáře, např.
.
Nikdy nepoužívejte dvě pomlčky (-) nikde jinde než na začátku a na konci vašich komentářů. Cokoli v komentářích je pro uživatele skutečně neviditelné Analyzátor XML, takže buďte velmi opatrní, aby to, co zbylo, bylo stále platné a dobře formované.
Balení
Pokud stále máte otázky ohledně přidávání referenčních komentářů do kódu XML, můžete si přečíst knihu, která vám poskytne podrobný obrázek o tom, jak tento proces funguje. Knihy jako„C # 5.0 Programmer's Reference“ od Roda Stephensa se může ukázat jako užitečné.