工作項目追蹤物件的命名慣例
所有工作項目追蹤物件都會與一個或多個名稱產生關聯。 大多數的追蹤物件都具有易記顯示名稱,而且除了工作項目類型和全域清單以外,所有的追蹤物件都會與參考名稱產生關聯。 易記名稱就是欄位之唯一、使用者可見的識別項,用於確保專案集合中的所有 Team 專案和工作項目類型的一致性。 此參考名稱會由 Team Foundation Server 在內部使用,而且在定義之後即無法變更。
下表將摘要列出每個工作項目追蹤物件必須符合的命名需求。
工作項目追蹤物件 |
參考名稱 |
易記名稱 |
---|---|---|
工作項目類型 |
不適用 |
每個工作項目類型的名稱最多可有 255 個 Unicode 字元,而且在 Team 專案內必須是唯一的名稱。 |
工作項目欄位 |
必要項。 請參閱參考名稱需求。 |
欄位名稱的長度最多為 128 個 Unicode 字元,而且在 Team 專案集合內必須是唯一的名稱。 |
連結類型 |
必要項。 請參閱參考名稱需求。 |
您可為每個連結類型定義兩個易記名稱:正向名稱和反向名稱。 這些名稱的長度最多為 128 個 Unicode 字元,而且對 Team 專案集合所定義的所有連結類型而言必須是唯一的名稱。 |
分類 |
必要項。 請參閱參考名稱需求。 |
分類易記名稱的長度最多為 128 個 Unicode 字元,而且在 Team 專案內必須是唯一的名稱。 |
全域清單 |
不適用 |
每個全域清單的名稱最多可有 254 個 Unicode 字元,而且在 Team 專案集合內必須是唯一的名稱。 |
主題內容
易記名稱需求
參考名稱需求
欄位參考名稱和可攜性需求
欄位參考名稱範例
易記名稱需求
除了本主題中上表摘要列出的需求以外,您定義的易記名稱應符合下列需求:
名稱不得為空白。
名稱的開頭與結尾不可以有空格。
名稱不可包含反斜線 (\) 字元。
欄位名稱不可包含下列字元:反斜線 (\)、句號 (.) 和左右括弧 ([])。
名稱不可包含兩個以上的連續空白字元。
參考名稱需求
當您加入或建立工作項目欄位、連結類型或分類時,您都必須定義參考名稱。 所有參考名稱的長度最多為 70 個 Unicode 字元。
您可以使用英數字元、底線字元和連字號字元來定義參考名稱。 每個參考名稱都必須至少包含一個句號 (.),但是句號不可以出現在名稱的開頭或結尾。 參考名稱不得以數字或底線為開頭,而且不得有多個連續短破折號,例如 (--)。
欄位參考名稱和可攜性
工作項目類型定義語言納入了「欄位參考名稱」(Field Reference Name) 的概念。 欄位參考名稱可協助您銜接 Team Foundation 專案集合之間的定義,並允許協力廠商整合尋找和參考特定欄位。 這類名稱是全域唯一的名稱,就如同 .NET Framework 應用程式中的命名空間是全域唯一的一般。
欄位參考名稱無法重新命名。 例如,如果您將欄位名稱從 "Title" 變更為 "Header",該欄位的欄位參考名稱仍然維持相同。 欄位的整合與內部表示應該使用欄位參考名稱,而不要只依靠欄位名稱。
System 命名空間僅用於定義 Team Foundation 系統功能所必要的所有核心系統欄位。 Team Foundation Server 會阻止您建立自己的 System.X 欄位,因為它可能會妨礙 Team Foundation Server 的功能。
Microsoft 命名空間用於定義 Microsoft Solutions Framework (MSF) 流程範本的工作項目類型定義中所定義的欄位。 Team Foundation Server 並不會阻止您建立自己的 Microsoft.X 欄位, 但是,我們強烈建議您不要這樣做,因為這可能會妨礙 Team Foundation Server 的功能。
客戶與合作夥伴也可以建立自己的欄位命名空間,以自訂工作項目類型。
如需 MSF for Agile Software Development - v5.0 所定義的系統欄位和相關欄位的描述,請參閱使用系統欄位和 MSF 流程範本所定義的欄位。
欄位參考名稱範例
下列範例示範各個命名空間中有效的欄位參考名稱:
System 命名空間範例
System.Id
System.Title
System.CreatedBy
System.CreationDate
System.ChangedBy
System.ChangedDate
System.State
System.Reason
Microsoft 命名空間範例
Microsoft.Common.Status
Microsoft.Common.Priority
Microsoft.Scheduling.Duration
Microsoft.Scheduling.PercentComplete
Microsoft.Testing.TestCaseName
其他命名空間中的範例
客戶與合作夥伴也可以定義自己的命名空間,以支援他們自訂的工作項目類型。 例如,Trey Research 這個虛構的公司可以定義下列自訂工作項目類型:
TreyResearch.Common.Severity
TreyResearch.Common.Phase
TreyResearch.RiskManagement.RiskType
TreyResearch.RiskManagement.Resolution
虛構軟體公司 A。 Datum Corporation 可以定義下列工作項目類型:
A_Datum.Common.BusinessPriority
A_Datum.Bug.FoundInPhase
A_Datum.Bug.FixInPhase