Как делать комментарии в xml

Зачем комментарии в xml, если можно придумать свой тег для этого?

Вот недавно я начал баловаться с xml, и подумал: «А зачем в xml комментарии если можно придумать свой тег для этого?», и ответ так и не нашёл, может вы поможете?

• Вопрос задан более года назад
• 67 просмотров

1 комментарий

Средний 1 комментарий

можно закомментировать часть DOM после помещения в комментарий сломать DOM что внутри

и ничего за
это не будет:

если вместо комментирования положить в ваш изобретенный тег и фрагмент DOMа внутри тега сломать:

то будет нехорошо всему документу

Решения вопроса 1

зачем придумывать, если уже есть комментарии?

коменты визуально отличаются от тегов, что упрощает чтение глазами.
коменты, в отличие от тега, автоматически пропускаются парсерами.
с коментами даже теоретически не возникнет казуса с дублирующими тегами.

Как программно узнать, есть ли у метода xml-комментарий?

Комментарии не вшиваются в сборку, они лежат в отдельном xml файле рядом со сборкой. Так что чисто технически у метода их никогда нет. Можно открыть этот файл и распарить — там достаточно простой формат.

– user177221
12 ноя 2021 в 8:52

Но это точно не стоит делать в виде юнит теста. Юнит тесты должны проверять поведение, а не наличие комментов

– user177221
12 ноя 2021 в 8:53

@PashaPash а каким образом предложите проводить тестирование наличия этих комментариев? Можно ли делать проверку в swagger?

12 ноя 2021 в 8:54
Скорее всего Вам нужно посмотреть в сторону статических анализаторов.
12 ноя 2021 в 9:51

Есть вот такая штука docs.microsoft.com/ru-ru/dotnet/csharp/language-reference/…, но там вроде надо специальный флаг компилятору добавлять.

12 ноя 2021 в 10:09

1 ответ 1

Сортировка: Сброс на вариант по умолчанию

1. При подключении сервиса swagger указать путь до автоматически сгенерированного файла с документацией проекта.
2. С помощью XDocument xdoc = XDocument.Load(SwaggerFile); получить файл с комментариями к swagger.
3. Можно расспарсить его следующим образом:

 .Element("members") .Elements("member") .Where(element => element.Attribute("name").Value.EndsWith("Controller")) .Select(element => new ControlClassWithDescription < Name = element.Attribute("name").Value, SummaryExist = element.Element("summary") != null, >); 

Предварительно создав класс ControlClassWithDescription .

1. Проверить в цикле все ли файлы с контроллерами есть в списке.

Отслеживать
ответ дан 17 ноя 2021 в 6:26
65 9 9 бронзовых знаков

• c#
• visual-studio

Важное на Мете

Похожие

Подписаться на ленту

Лента вопроса

Для подписки на ленту скопируйте и вставьте эту ссылку в вашу программу для чтения RSS.

Дизайн сайта / логотип © 2024 Stack Exchange Inc; пользовательские материалы лицензированы в соответствии с CC BY-SA . rev 2024.1.8.3130

Нажимая «Принять все файлы cookie» вы соглашаетесь, что Stack Exchange может хранить файлы cookie на вашем устройстве и раскрывать информацию в соответствии с нашей Политикой в отношении файлов cookie.

Рекомендуемые XML-теги для комментариев к документации по C#

В комментариях к документации по C# используются XML-элементы, что позволяет определить структуру выходной документации. Одним из последствий использования этой функции является то, что в комментарии к документации можно добавить любой допустимый XML-код. Компилятор C# копирует эти элементы в выходной XML-файл. Несмотря на то что в комментариях (включая любой допустимый HTML-элемент) можно использовать любой допустимый XML-код, документирование кода рекомендуется по многим причинам.

Далее приводится ряд рекомендаций, распространенные сценарии использования и вопросы, которые нужно иметь в виду при работе с тегами XML-документации в коде C#. Несмотря на то что теги можно поместить в комментарии к документации, в этой статье описываются рекомендуемые теги для наиболее распространенных конструкций языка. Во всех случаях следует соблюдать следующие рекомендации:

• Для обеспечения согласованности все открытые типы и их члены должны быть задокументированы.
• Закрытые члены можно также задокументировать с помощью XML-комментариев. Однако это приводит к раскрытию внутренних (возможно, конфиденциальных) процессов библиотеки.
• Как минимум, типы и их члены должен иметь тег , так как его содержимое требуется для IntelliSense.
• Текст документации должны быть написан с использованием законченных предложений, в конце которых ставится точка.
• Разделяемые классы полностью поддерживаются, и данные о документации объединяются в одну запись для этого типа.

Документация XML начинается с /// . При создании проекта шаблоны добавляют несколько строк /// . Обработка этих комментариев имеет некоторые ограничения.

• Документация должна представлять собой XML с правильным форматом. Если XML сформирован неправильно, компилятор выдает предупреждение. Файл документации будет содержать комментарий, в котором сообщается, что обнаружена ошибка.
• Некоторые рекомендуемые теги имеют особые значения.
  • Тег используется для описания параметров. При использовании этого тега компилятор проверяет, что параметр существует и все параметры описаны в документации. При сбое проверки компилятор выдает предупреждение.
  • Атрибут cref может быть присоединен к любому тегу для ссылки на элемент кода. Компилятор проверяет наличие этого элемента кода. При сбое проверки компилятор выдает предупреждение. Компилятор учитывает любые операторы using при поиске типа, описанного в атрибуте cref .
  • Тег используется технологией IntelliSense в Visual Studio для отображения дополнительных сведений о типе или элементе.

  Примечание XML-файл не предоставляет полную информацию о типе и членах (например, он не содержит никаких сведений о типе). Чтобы получить полную информацию о типе или элементе, используйте файл документации вместе с отражением для текущего типа или элемента.

  Некоторые из рекомендуемых тегов можно использовать для любого элемента языка. Другие имеют более специализированное использование. Наконец, некоторые теги используются для форматирования текста в документации. В этой статье описываются рекомендуемые теги, упорядоченные по их использованию.

  Компилятор проверяет синтаксис элементов, за которым следует один символ * в следующем списке. Visual Studio предоставляет IntelliSense для тегов, проверенных компилятором, и всех тегов, за которыми следует **, в следующем списке. Помимо указанных здесь тегов, компилятор и Visual Studio проверяют теги , , ,
  и . Компилятор также проверяет , который является устаревшим тегом HTML.

  • Общие теги, используемые для нескольких элементов. Эти теги являются минимальным набором для любого API.
    • : значение этого элемента отображается в IntelliSense в Visual Studio.
    • **
    • : значение этого элемента отображается в IntelliSense в Visual Studio.
    • *: значение этого элемента отображается в IntelliSense в Visual Studio.
    • *
    • : значение этого элемента отображается в IntelliSense в Visual Studio.
    • **
    • **
    • *
    • *
    • *
    • cref
    • href
    • *: значение этого элемента отображается в IntelliSense в Visual Studio.

    Комментарии документации не применяются к пространству имен.

    Чтобы ввести в текст комментария документации угловые скобки, используйте для символов < и >коды HTML < и > соответственно. Это показано в следующем примере.

    /// 
    /// This property always returns a value < 1. ///
     

    Общие теги

    description
     

    Тег следует использовать для описания типа или элемента типа. Используйте для добавления дополнительных сведений в описание типа. Чтобы включить средства документации, такие как DocFX и Sandcastle, для создания внутренних гиперссылок на страницы документации для элементов кода, используйте атрибут cref. Текст в теге является единственным источником сведений о типе для технологии IntelliSense и также отображается в окне обозревателя объектов.

     description 

    Тег используется для добавления сведений о типе или члене типа, дополняя указанные сведения сводкой<>. Эти сведения отображаются в окне «Обозреватель объектов». Этот тег может содержать более длинные объяснения. Возможно, вы обнаружите, что использование разделов CDATA для разметки упрощает написание. Такие средства, как docfx, обрабатывают текст разметки в разделах CDATA .

    Члены документа

    description 

    Тег следует использовать в комментариях к объявлению метода для описания возвращаемого значения.

    description 

    • name : имя параметра метода. Имя заключается в двойные кавычки (» «). Имена параметров должны соответствовать сигнатуре API. Если один или несколько параметров не охвачены, компилятор выдает предупреждение. Компилятор также выдает предупреждение, если значение name не соответствует формальному параметру в объявлении метода.

    Тег следует использовать в комментариях к объявлению метода для описания одного из параметров такого метода. Чтобы задокументировать несколько параметров, используйте несколько тегов . Текст тега отображается в IntelliSense, обозревателе объектов и веб-отчете по комментариям к коду.

    • name : имя параметра, на который указывается ссылка. Имя заключается в двойные кавычки (» «).

    Тег позволяет указать, что слово в комментариях к коду, например в блоке или , ссылается на параметр. В XML-файл такое слово может выделяться особым образом, например курсивом или полужирным шрифтом.

    description 

    • cref : ссылка на исключение, которое доступно из текущей среды компиляции. Компилятор проверяет, существует ли исключение, и приводит member к каноническому имени элемента в выходных XML-данных. member необходимо заключать в двойные кавычки (» «).

    Тег служит для указания возможных исключений. Этот тег может применяться к определениям методов, свойств, событий и индексаторов.

    property-description 

    Тег позволяет описывать значение, которое представляется свойством. При добавлении свойства с помощью мастера кода в среде разработки Visual Studio .NET добавляется тег сводки<> для нового свойства. Следует вручную добавить тег для описания значения, которое представляется свойством.

    Форматирование выходных данных документации

      This is an introductory paragraph. This paragraph contains more details.  

      term description  Assembly The library or executable built from a compilation.   

    Блок используется для определения строки заголовка в таблице или списке определений. При определении таблицы необходимо ввести данные для term в заголовке. Каждый элемент в списке указывается в блоке . При создании списка определений необходимо указать одновременно term и description . Тем не менее для таблицы, маркированного или нумерованного списка достаточно ввести только description . Число блоков в списке или таблице не ограничено.

    text 

    С помощью тега можно указать, что текст в описании необходимо пометить как код. Используйте , чтобы указать несколько строк в виде кода.

     var index = 5; index++; 

     This shows how to increment an integer. var index = 5; index++;  

    Тег позволяет указать пример использования метода или другого элемента библиотеки. В качестве примера обычно используется .

    Повторное использование текста документации

    Наследование XML-комментариев от базовых классов, интерфейсов и аналогичных методов. Использование inheritdoc позволяет обойтись без копирования и вставки одинаковых XML-комментариев и автоматически поддерживать их синхронизацию. Обратите внимание, что при добавлении тега к типу все члены также будут наследовать эти комментарии.

    • cref : укажите член для наследования документации. Унаследованные теги не переопределяют уже определенные теги для текущего элемента.
    • path : запрос с выражением XPath, в результате которого выводится набор узлов. С помощью этого атрибута можно отфильтровать теги, которые следует включить в наследуемую документацию или исключить из нее.

    Добавьте XML-комментарии в базовые классы или интерфейсы, и InheritDoc скопирует их во все реализации классов. Добавьте XML-комментарии в синхронные методы, и InheritDoc скопирует их в асинхронные версии аналогичных методов. Если нужно скопировать комментарии из определенного элемента, укажите нужный элемент в атрибуте cref .

    • filename : имя XML-файла, содержащего документацию. Имя файла может быть квалифицировано с помощью относительного пути к файлу исходного кода. filename необходимо заключать в одинарные кавычки (‘ ‘).
    • tagpath : путь тегов в filename , который ведет к тегу name . Путь необходимо заключать в одинарные кавычки (‘ ‘).
    • name : спецификатор имени в теге, предшествующий комментариям. name будет иметь идентификатор id .
    • id : идентификатор тега, который предшествует комментариям. Идентификатор заключается в двойные кавычки (» «).

    Тег позволяет задать ссылку на комментарии в другом файле, которые описывают типы и элементы вашего исходного кода. Включение внешнего файла является альтернативой размещению комментариев документации непосредственно в файле исходного кода. Помещая комментарии документации в отдельный файл, вы можете реализовать управление их версиями отдельно от версий исходного кода. В этом случае файл исходного кода может быть извлечен для изменения одним пользователем, а файл документации — другим. Тег использует XML-синтаксис XPath. Сведения об использовании тега см. в документации по XPath.

    Создание ссылок и гиперссылок

      Link text Link Text  

    • cref=»member» : ссылка на член или поле, которые доступны для вызова из текущей среды компиляции. Компилятор проверяет, существует ли элемент кода, и передает member в имя элемента в выходных XML-данных. member необходимо заключать в двойные кавычки (» «). Можно указать другой текст ссылки для «cref», используя отдельный закрывающий тег.
    • href=»link» : гиперссылка на заданный URL-адрес. Например, GitHub формирует гиперссылку с текстом GitHub, которая ведет на сайт https://github.com .
    • langword=»keyword» : язык ключевое слово, например true или одно из других допустимых ключевых слов.

    Тег позволяет задать ссылку из текста. Используйте , чтобы указать, что текст должен быть помещен в раздел См. также. Используйте атрибут cref для создания внутренних гиперссылок на страницы документации для элементов кода. Вы включаете параметры типа, чтобы указать ссылку на универсальный тип или метод, например cref=»IDictionary» . Кроме того, href является допустимым атрибутом, который будет функционировать как гиперссылка.

      Link Text 

    • cref=»member» : ссылка на член или поле, которые доступны для вызова из текущей среды компиляции. Компилятор проверяет, существует ли элемент кода, и передает member в имя элемента в выходных XML-данных. member необходимо заключать в двойные кавычки (» «).
    • href=»link» : гиперссылка на заданный URL-адрес. Например, GitHub формирует гиперссылку с текстом GitHub, которая ведет на сайт https://github.com .

    С помощью тега можно указать текст, который должен отображаться в разделе См. также. Используйте , чтобы указать ссылку из текста. Тег seealso нельзя вложить в тег summary .

    Атрибут cref

    Атрибут cref в теге XML-документации означает «ссылка на код». Он указывает, что внутренний текст тега является элементом кода, например типом, методом или свойством. Средства создания документации, такие как DocFX и Sandcastle, используют атрибуты cref для автоматического создания гиперссылок на страницу, где документирован тип или член.

    Атрибут href

    Атрибут href означает ссылку на веб-страницу. Его можно использовать для прямой ссылки на интерактивную документацию по API или библиотеке.

    Универсальные типы и методы

    The type returned from this method 

    • TResult : имя параметра типа. Имя заключается в двойные кавычки (» «).

    Тег следует использовать в комментариях к объявлению универсального типа или метода для описания параметра типа. Добавьте такой тег для каждого параметра типа универсального типа или метода. Текст для тега будет отображаться в IntelliSense.

    • TKey : имя параметра типа. Имя заключается в двойные кавычки (» «).

    Используйте этот тег, чтобы разрешить получателям файла документации форматировать слово определенным образом, например курсивным шрифтом.

    Пользовательские теги

    Все описанные выше теги распознаются компилятором C#. Тем не менее пользователь может определять собственные теги. Такие средства, как Sandcastle, поддерживают дополнительные теги, такие как и , и даже поддерживают документирование пространств имен. Средства создания пользовательской или внутренней документации также можно использовать со стандартными тегами. Кроме того, поддерживается несколько выходных форматов — от HTML до PDF.

    Совместная работа с нами на GitHub

    Источник этого содержимого можно найти на GitHub, где также можно создавать и просматривать проблемы и запросы на вытягивание. Дополнительные сведения см. в нашем руководстве для участников.

    Формирование структуры документов для экспорта в XML

    На панели «Структура» в иерархическом виде отображаются объекты документа, имеющие разметку XML-тегами. Эти объекты называются элементами. Элементы на панели «Структура» можно перемещать, определяя их порядок и иерархию. Каждый элемент представлен в виде имени тега и значка, указывающего его тип.

    

    A. Значки треугольников для разворачивания или сворачивания элементов B. Элемент C. Текстовый сниппет D. Атрибут

    Кроме того, элементы могут представлять следующую информацию.

    Синий ромб на значке элемента означает, что элемент присоединен к объекту страницы. Отсутствие синего ромба указывает на то, что элемент не присоединен ни к одному из объектов страницы.

    Если объект страницы, которому соответствует данный элемент, выделен, то имя тега подчеркнуто. Например, при выделении текста, размеченного тегом Title , на панели «Структура» элемент Title будет подчеркнут. Подчеркивание показывает, соответствуют ли выделенные объекты страницы элементам панели «Структура».

    Справа от элемента могут отображаться первые 32 символа текста с тегами (текстовый сниппет). Такие сниппеты помогают идентифицировать объект страницы, которому соответствует элемент.

    Точка и атрибут

    Атрибуты предоставляют метаданные элемента. Если к элементу присоединены атрибуты, под ним отображается черная точка, а также имена и значения атрибутов.

    Использование панели «Структура»

    • Чтобы открыть палитру Структура , выберите Просмотр > Структура > Показать структуру .
    • Чтобы закрыть палитру Структура , выберите Просмотр > Структура > Скрыть структуру или нажмите кнопку разделителя.
    • Чтобы свернуть или развернуть элемент (и скрыть или отобразить его дочерние элементы), щелкните значок треугольника рядом с этим элементом.
    • Чтобы изменить размер палитры Структура , перетащите разделитель.
    • Чтобы свернуть или развернуть элемент, а также все содержащиеся в нем дочерние элементы, щелкните значок треугольника рядом с ним, удерживая нажатой клавишу Ctrl (Windows) или Command (macOS).
    • Чтобы отобразить или скрыть текстовые сниппеты, выберите Показать сниппеты или Скрыть сниппеты в меню палитры Структура .

    Значки панели «Структура»

    На панели «Структура» отображаются следующие значки.

    

    Каждый документ имеет один корневой элемент, расположенный в верхней строке, который может быть переименован, но не может быть ни удален, ни перемещен.

    

    Представляет размеченные тегами материалы (один или несколько связанных фреймов).

    

    Представляет текст с тегами, расположенный внутри фрейма.

    

    Представляет размеченный фрейм, содержащий изображение. Каждый графический элемент имеет атрибут «href», который указывает путь или URL связанного файла.

    

    Неразмещенный текстовый элемент

    Текстовый элемент, который еще не связан с элементом страницы.

    

    Неразмещенный графический элемент

    Графический элемент, который еще не связан с элементом страницы.

    

    

    Элемент ячейки заголовка

    Представляет ячейку, расположенную в заголовочной строке таблицы.

    

    Элемент ячейки основной строки

    Представляет ячейку, расположенную в основной строке таблицы.

    

    Элемент ячейки нижнего колонтитула

    Представляет ячейку, расположенную в нижней строке таблицы.

    

    С этим элементом связан пустой фрейм.

    

    Содержит метаданные, например ключевые слова или сведения о местоположении связанного изображения (атрибут HREF).

    

    Включает комментарии, которые видны в XML-файле, но не в документе InDesign.

    

    Инструкция по обработке

    Содержит инструкцию, которая запускает какое-либо действие в приложениях, умеющих считывать инструкции по обработке.

    

    Указывает Indesign DTD-файл, который необходимо использовать при проверке XML-файла.

    Изменение расположения структурных элементов

    Порядок и положение в иерархии элементов на панели «Структура» могут быть изменены. При этом необходимо соблюдение следующих правил.

    • XML-документ должен иметь один корневой элемент, находящийся в верхней строке структуры. Корневой элемент включает в себя все остальные элементы и является их родителем. Выше корневого элемента на панели «Структура» могут находиться только DTD (который отображается в виде элемента DOCTYPE), комментарии и инструкции по обработке.
    • Изменения иерархической структуры XML могут повлиять на отображение размеченных тегами элементов на страницах InDesign. Например, если сделать текстовый элемент дочерним элементом какого-либо другого элемента в структуре, то текст в макете также переместится в другое место.
    • Перетаскивание элемента ячейки таблицы или других элементов в элемент таблицы не допускается.

    На панели «Структура» выполните одно из действий, описанных ниже.

    • Чтобы переместить элемент, перетащите его на новое место в пределах структуры. При перетаскивании отображается линия, указывающая место вставки элемента. Ширина линии показывает уровень в иерархии.
    • Чтобы сделать элемент дочерним другого элемента или разместить его над родительским элементом, выделите его или поместите среди родительских элементов других дочерних элементов, а затем отпустите кнопку мыши.
    • Чтобы переместить элемент в иерархии на уровень ниже, перетащите его под другой родительский элемент и немного передвиньте влево, пока линия, показывающая его размещение, не сравняется по ширине с родительским элементом.
    • Чтобы скопировать или вырезать элемент, выделите его (или несколько элементов) на панели «Структура» и выберите меню «Редактирование» > «Скопировать» или «Редактирование» > «Вырезать». Выделите элемент, перед которым необходимо вставить скопированный элемент, а затем выберите меню «Редактирование» > «Вставить».

    Примечание.

    При вырезании элемент вместе с содержимым помещается в буфер обмена. Фрейм, в котором он содержался, остается без изменений.

    Вставка родительского элемента

    Чтобы обеспечить правильность структуры XML и лучше упорядочить содержимое, вставьте на панель «Структура» родительский элемент. Но перед этим необходимо выделить элементы, которые будут его дочерними элементами. После вставки нового родительского элемента выделенные дочерние элементы перемещаются в структурной иерархии на один уровень ниже.

    

    

    На панели «Структура» выделите элементы, которые будут дочерними элементами нового родительского элемента. Обратите внимание на следующие моменты.

    • Нельзя выделить корневой элемент и элементы корневого уровня.
    • Нельзя выделить элемент «Материал» и элементы его уровня.
    • Элементы должны находиться на одном уровне иерархии.
    • Элементы должны быть смежными.
    • Выделение не должно включать ячейки таблиц или атрибуты.

    В меню палитры Структура выберите команду Создать родительский элемент , щелкните правой кнопкой мыши (Windows) или щелкните при нажатой клавише Control (macOS) и выберите команду Создать родительский элемент .

    Выберите тег для нового родительского элемента и нажмите кнопку ОК .
    Примечание.

    Чтобы быстро вставить новый родительский элемент, выберите команду Добавить тег на палитре Теги , а затем выберите нужный тег в палитре. Вы также можете щелкнуть правой кнопкой мыши (Windows) или щелкнуть при нажатой клавише Control (macOS) на элементе, выбранном на палитре Структура , выбрать команду Создать родительский элемент , после чего выбрать нужный элемент.

    Работа с атрибутами

    Атрибут предоставляет дополнительную информацию об XML-элементе. Каждый атрибут состоит из имени и значения. Атрибуты отображаются на панели «Структура». Они не помещаются в документ и не используются в качестве его содержимого. Можно добавлять атрибуты с элементами, что позволяет обеспечить преимущество при работе с файлами и приложениями, использующими XML-файлы, созданные в InDesign.

    При разметке тегами изображений InDesign автоматически создает атрибут href со значением, которое указывает местоположение файла изображения на диске. Благодаря атрибуту href другие файлы и приложения могут найти изображение и отобразить его.

    

    Атрибуты могут быть добавлены к любым элементам, кроме DOCTYPE (DTD-файл), комментариев и инструкций по обработке. Например, чтобы добавить ключевые слова для поиска в целевом приложении, можно создать атрибут keywords. Кроме того, атрибуты могут создаваться для указания подстановочного текста, отслеживания названий статей и сохранения любой другой информации, касающейся содержимого документа.

    Примечание.

    Если используется DTD-файл, просмотрите его содержимое, чтобы определить, какие атрибуты допустимы. Имена атрибутов, как и имена тегов, должны соответствовать DTD.

    Примечание.

    InDesign распознает специальные атрибуты пространств имен, которые могут определять стили абзацев и символов, таблиц и их ячеек, а также управлять пробелами. Дополнительную информацию см. в руководстве по InDesign.

    Добавление атрибута

    Выделите элемент.
    Выполните одно из действий, описанных ниже.

    

    • Нажмите кнопку Добавить атрибут .
    • Выберите команду Создать атрибут в меню палитры Структура .
    • Щелкните выделенный элемент правой кнопкой мыши (Windows) или щелкните его при нажатой клавише Control (macOS) и выберите команду Создать атрибут .

    Укажите имя и значение атрибута, а затем нажмите кнопку «ОК».

    Отображение и скрытие атрибутов на панели «Структура»

    В меню панели «Структура» выберите команду «Показать атрибуты» или «Скрыть атрибуты».
    Возможно, придется щелкнуть значок треугольника рядом с элементом, чтобы отобразить его атрибуты.

    Редактирование или удаление атрибута

    Выделите атрибут на панели «Структура».
    Выполните одно из действий, описанных ниже.

    • Чтобы изменить атрибут, дважды щелкните его или выберите в меню панели «Структура» команду «Редактировать».
    • Чтобы удалить атрибут, щелкните значок «Удалить» или выберите в меню панели «Структура» команду «Удалить».

    Редактирование атрибутов «href»

    При обработке файлов изображений InDesign автоматически создает атрибуты href . Атрибут href задает расположение файла изображения на диске, делая возможным его отображение. При разметке тегами помещенного изображения InDesign создает атрибут href , содержащий путь к изображению и имя файла.

    Путь может представлять собой абсолютную ссылку, относительную ссылку на папку, в которой хранится XML-файл, либо относительную ссылку на подпапку «Images» папки, в которой хранится XML-файл. Относительные пути ограничены папкой, в которой сохраняется документ.

    • Атрибут href , содержащий абсолютный путь, имеет следующий вид (в Windows и Mac OS): href=file:///C:/Images/Meadow.psd href=file:///Users/abhayc//Desktop/abc.jpg
    • Атрибут href для файла изображения, находящегося в той же папке, что и XML-файл, имеет следующий вид: href=file:Meadow.psd
    • Атрибут href для файла изображения, находящегося в папке «Images», имеет следующий вид: href=file:///Images/Meadow.psd

    Атрибут href можно изменить, указав новую ссылку на изображение. Например, абсолютную ссылку можно заменить на относительную, обеспечив доступность файла изображения после экспорта.

    На панели «Структура» дважды щелкните атрибут href (возможно, придется щелкнуть значок треугольника рядом с элементом, чтобы отобразить этот атрибут).

    В качестве параметра «Значение» введите новый путь к изображению и нажмите кнопку «ОК».

    Добавление комментариев и инструкций по обработке

    InDesign позволяет добавлять в XML-файлы комментарии и инструкции по обработке. Комментарии содержат описательную информацию об элементе. Они доступны для просмотра в веб-браузерах и текстовых редакторах и могут помочь другим пользователям разобраться со структурой и тегами XML-файла. Инструкция по обработке — это специальная команда, специфичная для приложения. Например, это может быть инструкция по разрывам страницы, позволяющая приложению, для которого экспортируется XML-файл, вставлять в нужных местах разрывы страниц. Подготавливаемые пользователями в InDesign инструкции по обработке предназначены для использования в других программах. Сама программа InDesign их не обрабатывает.

    

    A. Инструкция по обработке B. Комментарий

    Комментарии и инструкции по обработке отображаются на панели «Структура». Они могут быть перемещены, изменены или удалены, как и любые другие элементы на панели «Структура». Однако они не могут содержать ни дочерних элементов, ни атрибутов.

    Добавление комментария

    Выделите элемент, для которого необходимо добавить комментарий.
    Примечание.

    Чтобы добавить комментарий к таблице, выделите элемент ячейки таблицы. Комментарии могут добавляться к ячейкам таблиц, но не к таблицам.

    Выберите в меню панели «Структура» команду «Новый комментарий».
    Введите комментарий в диалоговом окне «Новый комментарий».

    Добавление инструкции по обработке

    Выделите элемент, к которому необходимо добавить инструкцию по обработке.
    Примечание.

    Чтобы добавить инструкцию по обработке к таблице, выделите элемент ячейки таблицы. Инструкции по обработке могут добавляться к ячейкам таблиц, но не к таблицам.

    Выберите в меню панели «Структура» команду «Новая инструкция по обработке».

    В качестве параметра «Назначение» введите имя, соответствующее инструкции по обработке, которое понятно приложению, обрабатывающему XML-файл после экспорта.

    В качестве параметра «Данные» введите значение, указывающее приложению, что делать с инструкцией по обработке.

    Похожие публикации:

    1. Где находится анимация в ворде
    2. Как запустить visual studio
    3. Как проверить функцию на линейность
    4. Служба журнала событий недоступна убедитесь что служба запущена