Ако се интересувате от добавяне на референтни коментари към вашия XML код, използвайте този урок стъпка по стъпка за насоки. Можете да научите как да изпълнявате тази функция само за пет минути. Въпреки че процесът е лесен за завършване, все пак трябва да знаете някои основи за XML коментарите и тяхната полезност, преди да започнете.
Защо XML коментарите са полезни
Коментарите в XML са почти идентични с коментарите в HTML, тъй като и двамата имат един и същ синтаксис. Използване на коментари ви позволява да разберете кода, който сте писали преди години. Също така може да помогне на друг разработчик, който преглежда кода, който сте разработили, да разбере какво сте написали. Накратко, тези коментари предоставят контекст на кода.
С коментари можете лесно да оставите бележка или временно да премахнете част от XML код. Въпреки че XML е проектиран да представлява „самоописани данни“, понякога може да се наложи да оставите XML коментар.
Приготвяме се да започнем
Таговете за коментари се състоят от две части: частта, която започва коментара и частта, която го завършва. За да започнете, добавете първата част на маркера за коментар:
След това напишете какъвто коментар искате. Просто се уверете, че не влагате коментари в други коментари (вижте съвети за повече подробности). След това ще затворите маркера за коментар:
-->
Полезни съвети
Когато добавяте референтни коментари към вашия XML код, не забравяйте, че те не могат да се намират в самия връх на вашия документ. В XML само XML декларацията може да бъде на първо място:
Както бе споменато по-горе, коментарите не могат да бъдат вложени един в друг. Трябва да затворите първия си коментар, преди да отворите втори. Също така, коментарите не могат да се появят в рамките на тагове, напр.
.
Никога не използвайте двете чертички (-) никъде, освен в началото и в края на вашите коментари. Всичко в коментарите е ефективно невидимо за XML парсер, така че бъдете много внимателни, че това, което остава, е все още валидно и добре оформено.
Обобщавайки
Ако все още имате въпроси относно добавянето на референтни коментари към XML код, може да искате да прочетете книга, за да ви даде подробна картина на това как работи процесът. Книги като„Справка за програмист C # 5.0“ от Род Стивънс може да се окаже полезно.