如何:发布代码段
更新:2007 年 11 月
若要使代码段显示在用户计算机上的代码编辑器中,必须将其安装在计算机上并使用“代码段管理器”导入到 Visual Studio 中。若要使此过程更加容易,可将代码段文件放在 Visual Studio 安装程序 (.vsi) 文件中,用户可使用 Visual Studio 内容安装程序将其放在正确的位置。然后,就可以轻松地与整个社区中的其他开发人员共享 .vsi 文件了。
.VSI 文件
.vsi 文件用于在开发人员社区中交换 Visual Studio 内容。.vsi 文件只是一个 .zip 文件,但它必须使用 .vsi 文件扩展名重命名,以便 Visual Studio 内容安装程序知道如何处理它。.vsi 文件包含以下内容:
一个 .vscontent 文件,其中包含用来描述 .vsi 文件内容并遵循特定的 XML 架构的 XML。有关 .vscontent 文件架构的完整定义,请参见如何:打包社区组件以使用 Visual Studio 内容安装程序。
内容文件(例如 .snippet 文件)。有关如何创建 .snippet 文件的信息,请参见如何:创建基本代码段。
Visual Studio 内容安装程序使用 .vsi 文件将共享内容安装到正确位置。有关如何安装 .vsi 文件的更多信息,请参见如何:安装社区组件。
必须在 .vscontent 文件中设置特定的值和属性,以便 Visual Studio 内容安装程序知道安装内容文件的方法和位置。例如,在代码段的 .vscontent 文件中必须执行下列操作:
将 FileContentType 元素值设置为 Code Snippet。
添加一个具有以下属性的 Attribute 元素:
- lang:将代码段的语言指定为 csharp、jsharp、vb 或 xml。
创建代码段 .vsi 文件
为内容创建一个有效的 .vscontent 文件。有关 .vscontent 文件架构的更多信息,请参见如何:打包社区组件以使用 Visual Studio 内容安装程序。
选择想要包含在 .vsi 文件中的文件(包括 .vscontent 文件),右击选择内容,单击“发送到”,然后单击“压缩(zipped)文件夹”。所选的文件将压缩为单个 .zip 文件。
将 .zip 文件的文件扩展名重命名为 .vsi。
说明: 若要在 Visual Studio 内容安装程序中显示您的代码段的出版商信息,您必须为 .vsi 文件签名。有关更多信息,请与数字证书供应商联系。
示例
下面的示例显示包含代码段的 .vsi 文件的一个 .vscontent 文件。该示例使用 ContentVersion 值 2.0。如果代码段可由 Visual Studio 或 Visual Studio 2008 使用,则使用 1.0 的值。如果代码段特定于 Visual Studio 2008,则使用 2.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 内容安装程序