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