<loc> (JavaScript)
指定提供當地語系化的 IntelliSense 資訊的歸位字元 (Carriage Return) 檔案的位置和型別。
<loc filename="filename" format="vsdoc|messagebundle" />
參數
filename
選擇項。 包含中性文化特性的當地語系化資訊的歸位字元 (Carriage Return) 檔案的主檔名。 當 Visual Studio 搜尋對於當地語系化資訊時,它會嘗試尋找這個檔案的特定文化特性的版本。 例如,如果是, filename jquery.xml, Visual Studio 會搜尋正確文化特性專用資料夾 (例如 JA) 在位置與包含項目的 <loc> .js 檔案相同。 如果它找到特定文化特性的資料夾,它會檢查 jquery.xml 檔案是否存在)。 如果無法找到正確的檔案,它會使用 Managed 資源位置規則。 filename 的預設值是目前檔案的名稱,不過,與 .xml 副檔名而不是組件。format
選擇項。 用於當地語系化的右邊的檔案類型。 使用指定 messagebundle Open Ajax 中繼資料訊息繫結所定義的使用。 messagebundle 是建議使用的格式。 不過,不支援這個格式 Microsoft Ajax 或 .winmd 檔案。 使用 vsdoc 指定執行階段 Microsoft Ajax 和的 Windows 使用的標準 .NET Framework 當地語系化格式。 這是一個選擇性的屬性。 vsdoc 是預設格式。
備註
<loc> 項目必須出現在部分的檔案頂端和 <reference> 項目相同。 <loc> 項目的使用方式規則與 <reference> 項目。 如需詳細資訊,請參閱 JavaScript IntelliSense「reference 指示詞」一節。
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>
}