Convenções de nomenclatura para objetos de acompanhamento de itens de trabalho
Em Visual Studio Team Foundation Server (TFS), todo objetos de acompanhamento de item de trabalho associados a um ou mais nomes. A maioria tem nomes para exibição amigável e tudo, exceto os tipos de item de trabalho e listas globais, estão associados com os nomes de referência. Um nome amigável é um identificador exclusivo, visível pelo usuário para um campo. Usando nomes amigáveis para garantir a consistência em todos os projetos de equipe e tipos de item de trabalho em uma coleção de projetos. TFS usa o nome de referência internamente e você não pode alterá-lo depois que ele está definido.
A tabela a seguir resume os requisitos de nomenclatura que devem ser atendidos para cada objeto de rastreamento de item de trabalho.
Objeto de rastreamento de item de trabalho |
Nome de referência |
Nome amigável |
|---|---|---|
Tipo de item de trabalho |
Não aplicável |
O nome de cada tipo de item de trabalho pode ter até 255 caracteres Unicode e deve ser exclusivo dentro de um projeto de equipe. |
Campo de item de trabalho |
Obrigatório. Consulte requisitos de nome de referência. |
Nomes de campo podem ter até 128 caracteres Unicode e devem ser exclusivos dentro de uma coleção de projetos de equipe. |
Tipo de vínculo |
Obrigatório. Consulte requisitos de nome de referência. |
Você define dois nomes amigáveis para cada tipo de link: encaminhar o nome e nome inversa. Esses nomes podem ter até 128 caracteres Unicode e devem ser exclusivos para todos os tipos de link definidos para uma coleção de projetos de equipe. |
Categoria |
Obrigatório. Consulte requisitos de nome de referência. |
Nomes amigáveis de categoria podem ter até 128 caracteres Unicode e devem ser exclusivos dentro de um projeto de equipe. |
Lista global |
Não aplicável |
O nome de cada lista global pode ter até 254 caracteres Unicode e deve ser exclusivo dentro de uma coleção de projetos de equipe. |
Requisitos de nome amigável
Além dos requisitos resumidos na tabela listada anteriormente neste tópico, os nomes amigáveis que você definir devem atender aos seguintes requisitos:
Os nomes não devem estar vazios.
Os nomes não podem ter espaços em branco no início ou no fim.
Os nomes não devem conter caracteres de barra invertida (\).
Nomes de campo não podem conter os seguintes caracteres: barra invertida (\), ponto (.) e abertura e fechamento quadrado colchetes ([]).
Nomes não podem conter dois ou mais espaços em branco consecutivos.
Requisitos de nome de referência
Você deve definir um nome de referência sempre que você adicionar ou cria um campo de item de trabalho, tipo de link ou categoria. Todos os nomes de referência podem ter até 70 caracteres Unicode.
Você pode definir um nome de referência usando caracteres alfanuméricos, caracteres sublinhados e hífens. Cada nome de referência deve conter pelo menos um ponto (.), mas nenhum período pode aparecer no início ou no final de um nome. Um nome de referência não pode começar com um número ou um sublinhado e não pode ter vários hifens consecutivos, como (-).
Portabilidade e nomes de campos de referência
A linguagem de definição de tipo de item de trabalho inclui o conceito de um nome de referência do campo. Nomes de campos de referência podem ajudá-lo a definições de porta entre Team Foundation coleções do projeto e também para permitir a integração de terceiros localizar e fazer referência a campos específicos. Esses nomes são globalmente exclusivos, como um namespace no aplicativo do .NET Framework é globalmente exclusivo.
Nomes de campos de referência não podem ser renomeados. Se, por exemplo, você alterou o nome do campo "Title" para "Cabeçalho", o nome de campo de referência de campo permanece o mesmo. Integrações e representações internas dos campos devem usar o nome de referência de campo em vez de dependendo no próprio nome de campo.
O namespace System é usado apenas para definir todos os principais campos do sistema que são obrigatórios para Team Foundation funções do sistema. Team Foundation Serverimpede que você crie seu próprio campo System.X porque ele pode impedir Team Foundation Server funcionalidade.
O namespace Microsoft é usado para definir campos de acompanhamento de item de trabalho. Esses campos são definidos em uma definição de tipo de item de trabalho dos modelos de processo do TFS. TFS não impede que você criar seu próprio campo Microsoft.X. No entanto, essa prática não é recomendável porque ele pode impedir Team Foundation Server funcionalidade do TFS ou a capacidade do Assistente Configurar recursos atualizar com êxito uma equipe de projeto após uma atualização do TFS.
Os clientes e parceiros podem criar seus próprios namespaces de campo para tipos de item de trabalho personalizados.
Para obter descrições dos campos do sistema e campos definidos nos modelos de processo do TFS, consulte Referência de campo de item de trabalho do Visual Studio ALM.
Exemplos de nomes de campos de referência
Os seguintes exemplos mostram os nomes de referência de campo válido em vários namespaces.
Exemplos de namespace do sistema
System.Id
System.Title
CreatedBy
System.CreationDate
System.ChangedBy
System.ChangedDate
System.State
System.Reason
Exemplos de namespace de Microsoft
Microsoft.Common.Status
Microsoft.Common.Priority
Microsoft.Scheduling.Duration
Microsoft.Scheduling.PercentComplete
Microsoft.Testing.TestCaseName
Exemplos de outros namespaces
Os clientes e parceiros também podem definir seus próprios namespaces para dar suporte a seus tipos de item de trabalho personalizados. Por exemplo, a empresa fictícia Trey Research pode definir os seguintes tipos de item de trabalho personalizados:
TreyResearch.Common.Severity
TreyResearch.Common.Phase
TreyResearch.RiskManagement.RiskType
TreyResearch.RiskManagement.Resolution
A empresa fictícia software A. Datum Corporation pode definir os seguintes tipos de item de trabalho:
A_Datum.Common.BusinessPriority
A_Datum.bug.FoundInPhase
A_Datum.bug.FixInPhase
Consulte também
Referência
Referência de elemento FIELD (definição)
Conceitos
Personalizar objetos de acompanhamento de trabalho para dar suporte aos processos da sua equipe