Získajte fakty s týmto postupným sprievodcom
Ak máte záujem o pridanie referenčných komentárov do kódu XML, použite tento návod krok za krokom. Môžete sa naučiť, ako vykonať túto funkciu za päť minút. Zatiaľ čo je proces ľahko dokončený, mali by ste ešte predtým zistiť niektoré základy o komentároch XML a ich užitočnosti.
Prečo sú komentáre XML užitočné
Komentáre v XML sú skoro identické s komentármi v HTML, pretože obe majú rovnakú syntax. Použitie pripomienok vám umožňuje pochopiť kód, ktorý ste napísali pred niekoľkými rokmi. Môže tiež pomôcť inému vývojárovi, ktorý skúma vyvíjaný kód, aby pochopil, čo ste napísali. Stručne povedané, tieto pripomienky poskytujú kontext pre kód.
Pomocou komentárov môžete ľahko zanechať poznámku alebo dočasne odstrániť časť kódu XML. Hoci XML je navrhnutý tak, aby bol "auto-opisujúci dáta", príležitostne budete musieť zanechať komentár XML.
Začíname
Značky na komentáre sa skladajú z dvoch častí: časť začínajúca komentár a časť, ktorá ho končí. Ak chcete začať, pridajte prvú časť komentára akýkoľvek komentár, ktorý by ste chceli. Jednoducho sa uistite, že nevložíte komentáre do iných komentárov (viac informácií nájdete v tipoch).
Potom zatvorte značku komentára ->
Užitočné tipy
Pri pridávaní referenčných komentárov do kódu XML nezabudnite, že nemôžu prichádzať na samý vrchol vášho dokumentu. V XML sa môže stať prvé iba deklarácia XML:
Ako už bolo uvedené vyššie, komentáre nemusia byť vnorené do vnútra iného. Pred otvorením sekundy musíte uzavrieť prvú poznámku. Tiež sa nemôžu vyskytnúť pripomienky v značkách, napr.
Nikdy nepoužívajte obe pomlčky (-) kdekoľvek, ale na začiatku a na konci vašich komentárov. Všetko v komentároch je pre analyzátora XML skutočne neviditeľné, takže buďte veľmi opatrní, že to, čo zostáva, je stále platné a dobre formované.
Zbaliť
Ak máte stále otázky týkajúce sa pridávania referenčných komentárov do kódu XML, možno budete chcieť prečítať knihu, ktorá vám poskytne podrobný obraz o tom, ako tento proces funguje. Knihy, ako napríklad referencia programátora C # 5.0 od Rod Stephens, sa môžu ukázať ako užitočné. Skontrolujte si online predajcov alebo miestnu knižnicu pre podobné knihy.