Fornecendo Texto de Descrição Resumida

Todo padrão e parâmetro inclui uma propriedade de Descrição Resumida para descrever resumidamente o uso ou finalidade do padrão ou parâmetro. Você pode fornecer uma descrição resumida ao incluir os novos padrões e parâmetros na biblioteca de padrões. Descrições resumidas também podem ser incluídas ou modificadas na visualização Propriedades.
Antes de Iniciar
Por Que e Quando Desempenhar Esta Tarefa

A descrição resumida é exibida para o aplicador do padrão na página Descrição Resumida da visualização Explorador de Padrões e na documentação de ajuda gerada. A descrição resumida do parâmetro também aparece em dois locais adicionais: nas janelas de parâmetros utilizadas para especificar argumentos para os parâmetros e no texto de dica de ferramenta na visualização do diagrama quando o usuário passa o cursor sobre o parâmetro na instância do padrão.

Para incluir descrições resumidas em padrões ou parâmetros:

  1. Na Visualização Autoria de Padrões, clique com o botão direito do mouse em um padrão ou parâmetro e clique em Mostrar Visualização de Propriedades.
  2. Na visualização Propriedades, clique na célula Valor para a propriedade Descrição Resumida e digite as informações que você deseja incluir.
O que Fazer Depois
Tarefas relacionadas
Incluindo Diagramas de Visão Geral de Padrão
Gerando Documentação da Biblioteca Padrão
Importando Documentação
Incluindo Documentação em Bibliotecas de Padrões

Feedback