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