Incluindo Componentes XML em Elementos .NET em Modelos UML

É possível incluir comentários de elementos XML em dois locais na visualização Propriedades: na página Documentação, ou na página Comentários XML.
Antes de Iniciar

A transformação de UML em C# ou o perfil .NET WCF deve ser aplicado ao modelo.

Na janela Preferências, expanda Modelagem > Miscelânea e verifique se a caixa de opção Exibir rich text em diagramas e documentação está desmarcada.

Por Que e Quando Desempenhar Esta Tarefa
Ao executar a Transformação de UML em C#, os comentários XML no modelo são gerados no código de origem como tags XML e como texto em campos de comentários especiais que precedem diretamente o bloco de código ao qual fazem referência. Ao executar a transformação de C# em UML, as tags XML no código de origem são geradas como comentários nas páginas Documentação e Comentários XML na visualização Propriedades.
Nota: Se os comentários XML aparecem em um arquivo de origem de código antes de uma diretiva do pré-processador, os comentários XML não são gerados no modelo, porque essas áreas são interpretadas com seções do código do usuário.

Para incluir comentários XML a elementos .NET usando a página Comentários XML:

  1. Crie um modelo que inclua elementos .NET que suportem comentários XML.
  2. No modelo, selecione um elemento .NET.
  3. Posicione o cursor no editor de página Comentários XML; depois clique em um botão para incluir a tag de abertura e fechamento da tag XML correspondente. Os atributos que são associados com a tag XML também são criados.
O que Fazer Depois

Em C#, é possível criar documentação para código incluindo tags XML em campos de comentário especiais no código de origem diretamente antes do bloco de código ao qual eles se referem.

Quando o código que contém comentários XML é compilado com a opção /doc, o compilador busca por todas as tags XML no código de origem e cria um arquivo de documentação XML. Para criar a documentação final com base no arquivo gerado pelo compilador é possível criar uma ferramenta customizada.


Feedback