<loc> (JavaScript)
指定提供本地化的Intellisense信息边车文件的位置和类型。
<loc filename="filename" format="vsdoc|messagebundle" />
参数
filename
可选。 包含非特定区域性的本地化信息边车文件的根名称。 在Visual Studio中搜索特定本地化信息时,它尝试查找该文件的一个区域性特定版本。 例如,因此,如果 filename 是jquery.xml,Visual Studio搜索正确的特定于区域性的文件夹(如JA)在位置和包含 <loc> 元素的.js文件同名。 如果它找到该特定于区域性的文件夹,它检查jquery.xml文件是否存在于它。 如果它不能定位到正确的文件,它使用托管资源位置规则。 filename 的默认值为当前文件的名称,但是,与扩展名为.xml而不是.js。format
可选。 用于本地化的边车文件的类型。 使用 messagebundle 指定了ajax元数据绑定消息定义的使用。 messagebundle 是推荐使用的格式。 但是,此格式不支持在Microsoft ajax或在.winmd文件。 使用 vsdoc 指定Microsoft ajax和Windows运行时使用的标准.NET Framework本地化格式。 此特性是可选的。 vsdoc 是默认的格式。
备注
<loc> 元素必须出现在部分的文件的顶部和 <reference> 元素相同。 <loc> 组件的用法规则相同。<reference> 元素。 有关更多信息,请参见中 JavaScript IntelliSense的“引用指令”一节。
Visual Studio进程每个.js文件的一个 <loc> 元素。 如果多个 <loc> 元素存在,因此,只有使用单个 <loc> 元素。 定位要使用哪种行为 <loc> 元素未定义。
在使用消息绑定窗体时,请使用 locid 属性在XML文档注释指定 name 属性值。
示例
下面的示例演示如何使用messagebundle格式的 <loc> 元素。 以下XML添加到名为messageFilename.xml的文件并将该文件放在正确的区域性特定文件夹,请在 filename 参数的声明中指定。
<?xml version="1.0" encoding="utf-8" ?>
<messagebundle>
<msg name="1">A class that represents a rectangle</msg>
<msg name="2">The height of a rectangle</msg>
<msg name="3">The width of a rectangle</msg>
</messagebundle>
对于messagebundle示例,请将以下代码添加到您的项目中的JavaScript文件。 <loc> 元素必须显示为JavaScript文件的第一行。 此代码中的如果有说明会本地化描述替换,。
/// <loc filename="messageFilename.xml" format="messagebundle"/>
function doSomething(a,b)
{
/// <summary locid='1'>description</summary>
/// <param name='a' locid='2'>parameter a description</param>
/// <param name='b' locid='3'>parameter b description</param>
}
下面的示例使用VSDoc格式。 以下XML添加到名为scriptFilename.xml的文件并将该文件放在正确的特定于区域性的文件夹。
<?xml version="1.0" encoding="utf-8" ?>
<doc>
<assembly>
<name>Lights</name>
</assembly>
<members>
<member name="M:illuminate">
<summary>Activates a light. </summary>
<param name='a'>The light to activate. </param>
</member>
</members>
</doc>
对于VSDoc示例,请将以下代码添加到您的项目中的JavaScript文件。 此代码中的如果有说明会本地化描述替换,。
/// <loc filename="scriptFilename.xml" format="vsdoc" />
function illuminate(a)
{
/// <summary locid='M:illuminate'>description</summary>
/// <param name='a' type='Number'>parameter a description</param>
}