Практическое руководство. Публикация фрагментов кода

Статья
08/11/2011

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

Файлы с расширением VSI

Файлы с расширением VSI служат для обмена содержимым Visual Studio в сообществе разработчиков. VSI-файл представляет собой просто ZIP-файл, но чтобы установщик содержимого Visual Studio мог понять, что делать с этим файлом, расширение имени файла должно быть VSI. VSI-файлы содержат следующее:

Файл с расширением .vscontent с XML, описывающим содержимое файла VSI и отвечающим определенной XML-схеме. Полное определение схемы файлов с расширением VSCONTENT см. в разделе Практическое руководство. Упаковка компонентов для использования установщика содержимого Visual Studio.
Файлы содержимого, например файл .snippet. Дополнительные сведения о создании файлов .snippet см. в разделе Практическое руководство. Создание простого фрагмента кода.

Установщик содержимого Visual Studio использует файлы VSI для установки общего содержимого в правильном расположении. Дополнительные сведения об установке VSI-файлов содержатся в разделе Практическое руководство. Поиск и установка компонентов, разработанных членами сообщества.

Необходимо задать определенные значения и атрибуты в файле .vscontent таким образом, чтобы установщик содержимого Visual Studio знал, как и где установить файлы содержимого. Например, в файле .vscontent фрагмента кода выполните следующие действия:

Присвойте элементу FileContentType значение Code Snippet.
Добавьте элемент Attribute, который имеет следующий атрибут:
- lang — задает язык фрагмента кода: csharp, vb, SQL, JScript, HTML, или xml.

Создание файла фрагмента кода VSI

Создайте правильный .vscontent файл для содержимого. Дополнительные сведения о схеме файла .vscontent см. в разделе Практическое руководство. Упаковка компонентов для использования установщика содержимого Visual Studio.
Выберите файлы, которые необходимо включить в файл VSI (в то числе файл .vscontent), щелкните правой кнопкой мыши выбранные файлы, выберите Отправить и нажмите кнопку Сжатая ZIP-папка. Выбранные файлы будут сжаты в один файл с расширением ZIP.
Переименуйте расширение имени файла с .zip на .vsi.

Примечание

Чтобы отобразить сведения публикации фрагмента кода в установщике содержимого Visual Studio, файл VSI необходимо подписать.Для получения дополнительных сведений, свяжитесь с поставщиком цифровых сертификатов.

Пример

В следующем примере показан файл .vscontent для файла VSI, содержащего фрагмент кода. В примере используется значение ContentVersion, равное 2,0. Если фрагмент кода характерен для Visual Studio 2008 или более поздней версии, используйте значение 2,0. Если фрагмент также может использоваться в Visual Studio 2005, используйте значение 1,0. Ниже перечислены файлы, которые должны быть включены в файл с расширением VSI.

Файл .vscontent, содержащий код из этого примера.
Фрагмент кода MyCodeSnippet.snippet.

<VSContent xmlns="https://schemas.microsoft.com/developer/vscontent/2005">
    <Content>
        <FileName>MyCodeSnippet.snippet</FileName>
        <DisplayName>Sample Code Snippet</DisplayName>
        <Description>A code snippet created for this example</Description>
        <FileContentType>Code Snippet</FileContentType>
        <ContentVersion>2.0</ContentVersion>
        <Attributes>
            <Attribute name="lang" value="vb"/>
        </Attributes>
    </Content>
</VSContent>

См. также

Задачи

Практическое руководство. Упаковка компонентов для использования установщика содержимого Visual Studio

Ссылки

Создание и использование фрагментов кода IntelliSense

Поделиться через