Како да додадете референтни коментари за вашиот XML код

Добијте ги фактите со овој чекор-по-чекор водич

Ако сте заинтересирани да додавате референтни коментари на вашиот XML код, користете го ова упатство чекор-по-чекор за упатство. Можете да научите како да ја извршите оваа функција за само пет минути. Додека процесот е лесно да се заврши, сепак треба да знаете некои основи за XML коментарите и нивната корисност пред да почнете.

Зошто XML коментарите се корисни

Коментари во XML се скоро идентични со коментарите во HTML, бидејќи и двете имаат истата синтакса. Користењето коментари ви овозможува да го разберете кодот што го напишавте години пред тоа. Исто така, може да му помогне на друг развивач кој го разгледува кодот што го развил да разбере што го напишавте. На кратко, овие коментари даваат контекст за кодот.

Со коментари, можете лесно да оставите белешка или привремено да отстраните дел од XML-код. Иако XML е дизајниран да биде "само-опишување на податоци", во одредени случаи можеби ќе треба да оставите XML коментар.

Да започнеме

Тегите за коментари се составени од два дела: делот кој го започнува коментарот и делот кој го завршува. За да започнете, додадете првиот дел од ознаката за коментар она што го коментирате . Само бидете сигурни дека не гнездите коментари во други коментари (видете ги советите за повеќе детали).

После тоа ќе ја затворите ознаката за коментар ->

Корисни совети

Кога додавате референтни коментари на вашиот XML-код, запомнете дека тие не можат да дојдат на самиот врв на вашиот документ. Во XML, само декларацијата за XML може да дојде прво:

Како што споменавме погоре, коментарите не може да се вклопат во внатрешноста. Мора да го затворите вашиот прв коментар пред да отворите секунда. Исто така, коментарите не можат да се појават во ознаките, на пример .

Никогаш не користете ги двете цртички (-) било каде, но на почетокот и крајот на вашите коментари. Нешто во коментарите е ефективно невидливо за парсерот на XML, па бидете внимателни дека она што останува е сеуште валидно и добро формирано.

Завиткување

Ако сеуште имате прашања за додавање на референтни коментари во XML-код, можеби ќе сакате да ја прочитате книгата за да ви дадете детална слика за тоа како функционира процесот. Книгите како референца на програмерот C # 5.0 од Rod Stephens може да се покажат како корисни. Проверете онлајн продавници или вашата локална библиотека за слични книги.