定义工作项字段的帮助文本

可以使用 HELPTEXT 元素将帮助文本与字段相关联,以便用户可以更好地理解要在该字段中指定的内容。 如果用户将鼠标指针指向工作项窗体中的字段,则会显示帮助文本。

<HELPTEXT>ToolTipText </HELPTEXT>

ToolTipText:包含 1 至 255 个字符的文本字符串。

与字段名和字段类型不同,帮助文本的范围限定在团队项目中的特定工作项类型。 因此,可以为不同团队项目中的同一字段自定义帮助文本。

只能将一个 HELPTEXT 元素指定为 FIELD(定义)元素的子元素。 有关如何指定帮助文本的更多信息,请参见在工作项窗体上提供帮助文本、过程指导、Web 内容和网页链接

备注

添加帮助文本会对可位于服务器上的项目数产生负面影响。如果遇到此问题,则减少帮助文本的数量会对元数据的大小产生显著影响,这有助于提高可伸缩性。如果必须在 Team Foundation Server 上存储数百个项目,请在工作项类型定义(XML 文件)中限制使用或不使用帮助文本。

下面的示例演示如何将帮助文本指派给 Title 字段:

<FIELD refname="System.Title" name="Title" type="String">
<HELPTEXT>Enter a brief description of the work item.</HELPTEXT>
</FIELD>

请参见

其他资源

定义工作项字段