Если вы заинтересованы в добавлении ссылочных комментариев к своему XML-коду, используйте это пошаговое руководство для руководства. Вы можете научиться выполнять эту функцию всего за пять минут. Несмотря на то, что этот процесс легко выполнить, вы все же должны знать некоторые основы о комментариях XML и их полезности, прежде чем начать.
Почему комментарии XML полезны
Комментарии в XML почти идентичны комментариям в HTML, так как оба имеют одинаковый синтаксис. Использование комментариев позволяет понять код, который вы написали много лет назад. Это также может помочь другому разработчику, который просматривает код, который вы разработали, понять, что вы написали. Короче говоря, эти комментарии обеспечивают контекст для кода.
С комментариями вы можете легко оставить заметку или временно удалить часть кода XML. Несмотря на то, что XML предназначен для «самоописания данных», иногда вам может понадобиться оставить комментарий XML.
Начиная
Теги комментариев состоят из двух частей: части, начинающей комментарий, и части, заканчивающей его. Для начала добавьте первую часть тега комментария:
Полезные советы
Добавляя ссылочные комментарии к вашему XML-коду, помните, что они не могут находиться в самом верху вашего документа. В XML только объявление XML может идти первым:
Как упоминалось выше, комментарии не могут быть вложенными друг в друга. Вы должны закрыть свой первый комментарий, прежде чем открыть второй. Кроме того, комментарии не могут появляться внутри тегов, например,
.
Никогда не используйте две черты (-) где-либо, кроме как в начале и в конце ваших комментариев. Все, что в комментариях, фактически невидимо для синтаксического анализатора XML, поэтому будьте очень осторожны, чтобы то, что осталось, все еще оставалось верным и корректным.
Завершение
Если у вас все еще есть вопросы о добавлении ссылочных комментариев в код XML, вы можете прочитать книгу, чтобы дать вам подробное представление о том, как этот процесс работает. Такие книги, как «Справочник программиста C # 5.0» Рода Стивенса, могут оказаться полезными.
