工作项跟踪对象的命名约定

在 Visual Studio Team Foundation Server (TFS) 中,所有工作项跟踪对象都与一个或多个名称关联。 大多数对象都具有友好显示名称,并且除工作项类型和全局列表之外的所有对象都与引用名称关联。 友好名称是字段的唯一的、用户可见的标识符。 使用友好名称可确保项目集合中所有团队项目和工作项类型的一致性。 TFS 在内部使用引用名称,定义之后无法对其进行更改。

下表总结了每个工作项跟踪对象必须满足的命名要求。

工作项跟踪对象

引用名称

友好名称

工作项类型

不适用

每个工作项类型的名称最长可为 255 个 Unicode 字符,在一个团队项目中必须唯一。

工作项字段

必需。 请参见引用名称要求。

字段名称最长可为 128 个 Unicode 字符,在一个团队项目集合中必须唯一。

链接类型

必需。 请参见引用名称要求。

可为每个链接类型定义两个友好名称:前向名称和反向名称。 这些名称最长可为 128 个 Unicode 字符,对于为一个团队项目集合定义的所有链接类型必须唯一。

类别

必需。 请参见引用名称要求。

类别友好名称最长可为 128 个 Unicode 字符,在一个团队项目中必须唯一。

全局列表

不适用

每个全局列表的名称最长可为 254 个 Unicode 字符,在一个团队项目集合中必须唯一。

友好名称要求

除了在本主题前面列出的表中总结的要求外,所定义的友好名称还应满足以下要求:

  • 名称不能是空的。

  • 名称不能有前导空白或尾随空白。

  • 名称不能包含反斜杠 (\) 字符。

  • 字段名称不能包含以下字符:反斜杠 (\)、句点 (.) 以及左方括号和右方括号 ([])。

  • 名称不能包含两个或更多连续空格。

引用名称要求

每当添加或创建工作项字段、链接类型或类别时,都必须定义引用名称。 所有引用名称最长可为 70 个 Unicode 字符。

可以使用字母数字字符、下划线字符和连字符来定义引用名称。 每个引用名称必须至少包含一个句点 (.),但不能以句点作为名称的开头或结尾。 引用名称不能以数字或下划线开头,而且不能包含多个连续的连字符,例如 (--)。

字段引用名称和可移植性

工作项类型定义语言包括“字段引用名称”的概念。 字段引用名称可帮助您在 Team Foundation 项目集合之间移植定义,还允许第三方集成查找和引用特定字段。 这些名称是全局唯一的,正如 .NET Framework 应用程序中的命名空间是全局唯一的一样。

不能对字段引用名称进行重命名。 例如,如果您将字段名称“Title”更改为“Header”,则该字段的字段引用名称将保持不变。 字段的集成和内部表示形式应使用字段引用名称,而不是取决于字段名称本身。

System 命名空间仅用于定义 Team Foundation 系统功能所必需的所有核心系统字段。 Team Foundation Server 禁止您创建自己的 System.X 字段,因为这可能会影响 Team Foundation Server 的功能。

Microsoft 命名空间用于定义工作项跟踪字段。 这些字段在 TFS 过程模板的工作项类型定义中定义。 TFS 并不禁止您创建自己的 Microsoft.X 字段。 但是,强烈建议不要采用此做法,因为这可能会影响 Team Foundation Server TFS 功能或配置功能向导的功能而无法在 TFS 升级之后成功更新团队项目。

客户和合作伙伴可以为自定义工作项类型创建自己的字段命名空间。

有关系统字段和在 TFS 过程模板中定义的字段的说明,请参见Visual Studio ALM 的工作项字段参考

字段引用名称的示例

下面的示例演示各个命名空间中有效的字段引用名称。

系统命名空间示例

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

请参见

参考

FIELD(定义)元素引用

概念

自定义工作跟踪对象以支持团队的进程