Ak máte záujem pridať k svojmu príspevku referenčné komentáre XML kód, použite ako návod tento podrobný návod. Ako sa táto funkcia vykonáva, sa dozviete iba za päť minút. Aj keď sa tento proces dá ľahko dokončiť, mali by ste ešte predtým, ako začnete, poznať základné informácie o komentároch XML a ich užitočnosti.
Prečo sú komentáre XML užitočné
Komentáre v XML sú takmer identické s komentármi v HTML, pretože obidve majú rovnakú syntax. Používanie komentárov umožňuje porozumieť kódu, ktorý ste napísali roky predtým. Môže tiež pomôcť ďalšiemu vývojárovi, ktorý kontroluje kód, ktorý ste vyvinuli, aby pochopil, čo ste napísali. Stručne povedané, tieto komentáre poskytujú kontext pre kód.
Pomocou komentárov môžete ľahko zanechať poznámku alebo dočasne odstrániť časť kódu XML. Aj keď je XML navrhnutý ako „údaj s vlastným popisom“, niekedy budete možno musieť zanechať komentár XML.
Začíname
Značky komentárov pozostávajú z dvoch častí: časti, ktorá začína komentár a časti, ktorá ju končí. Na začiatok pridajte prvú časť značky komentára:
Potom napíšte ľubovoľný komentár, ktorý by ste chceli. Dajte pozor, aby ste komentáre nevnorili do iných komentárov (ďalšie tipy nájdete v tipoch). Potom zavriete značku komentára:
-->
Užitočné tipy
Pri pripájaní referenčných komentárov k svojmu kódu XML nezabudnite, že sa nemôžu nachádzať na samom vrchu dokumentu. V XML môže byť na prvom mieste iba deklarácia XML:
Ako už bolo spomenuté vyššie, komentáre nemôžu byť vnorené jeden do druhého. Predtým, ako otvoríte druhý, musíte uzavrieť svoj prvý komentár. Komentáre sa tiež nemôžu vyskytovať v rámci značiek, napr.
.
Nikdy nepoužívajte dve pomlčky (-) nikde inde ako na začiatku a na konci svojich komentárov. Čokoľvek v komentároch je pre používateľov skutočne neviditeľné Parser XML, takže buďte veľmi opatrní, aby to, čo zostane, bolo stále platné a dobre sformované.
Balenie
Ak stále máte otázky týkajúce sa pridávania referenčných komentárov do kódu XML, môžete si prečítať knihu, ktorá vám poskytne podrobný obraz o tom, ako tento proces funguje. Knihy ako napr„Referencia programátora C # 5.0“ od Roda Stephensa sa môže ukázať ako užitočné.