Získejte fakta s tímto podrobným průvodcem
Máte-li zájem o přidání referenčních komentářů k kódu XML, použijte tento návod krok za krokem. Můžete se naučit, jak tuto funkci vykonat během pouhých pěti minut. Zatímco proces je snadné dokončit, měli byste ještě znát nějaké základy o komentářích XML a jejich užitečnosti dříve, než začnete.
Proč XML komentáře jsou užitečné
Komentáře v XML jsou téměř shodné s komentáři v HTML, protože oba mají stejnou syntaxi. Použití komentářů vám umožňuje pochopit kód, který jste napsali před lety. Může také pomoci dalšímu vývojáři, který přezkoumává kód, který jste vyvinuli, pochopit to, co jste napsali. Stručně řečeno, tyto komentáře poskytují kontext pro kód.
Pomocí poznámek můžete snadno nechat poznámku nebo dočasně odstranit část kódu XML. I když je XML určen jako "auto-popisující data", někdy možná budete muset nechat komentář XML.
Začínáme
Značky komentářů se skládají ze dvou částí: část, která začíná komentář a část, která jej končí. Začněte přidáním první části komentáře libovolný komentář, který byste chtěli. Jen se ujistěte, že nevložíte komentáře do dalších komentářů (další tipy naleznete v tématu).
Poté zavřete značku komentáře ->
Užitečné tipy
Při přidávání referenčních poznámek k kódu XML nezapomeňte, že nemohou přijít na úplný vrchol dokumentu. Ve formátu XML může nastat první XML deklarace:
Jak již bylo uvedeno výše, komentáře nesmí být vnořeny do sebe. Před otevřením sekundy musíte svůj první komentář uzavřít. Ve značkách se také nevyskytují komentáře, např.
Nikdy nepoužívejte obě pomlčky (-) nikde, ale na začátku a na konci komentářů. Cokoliv v komentářích je pro analyzátor XML skutečně neviditelné, takže buďte velmi opatrní, co zůstane, je stále platné a dobře formované.
Obalování nahoru
Pokud máte stále 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ý přehled o tom, jak tento proces funguje. Knihy jako C # 5.0 Programmer's Reference Rod Stephens se mohou ukázat jako užitečné. Podívejte se na online prodejce nebo místní knihovnu pro podobné knihy.