Incluindo Documentação em Bibliotecas de Padrões

A biblioteca de padrões mantém informações sobre seus padrões de membro em um arquivo de dados estáticos. Você pode incluir a documentação nesse arquivo de manifesto de biblioteca para ser utilizado pelo aplicador do padrão.

Um pequeno subconjunto de informações da biblioteca é exibido na ajuda on-line quando o aplicador do padrão clica no item de menu Mostrar Documentação do Padrão na visualização Explorador de Padrões. Você pode incluir uma descrição resumida nessas informações da biblioteca.

O arquivo de manifesto da biblioteca possui o mesmo nome que a biblioteca, com uma extensão de arquivo .rmd.

Para incluir uma descrição resumida na biblioteca:

  1. Na visualização Explorador de Pacotes, localize e expanda o nó PatternFiles no projeto de padrão.
    Uma pasta PatternFiles expandida de um projeto de padrão.
  2. Dê um clique duplo no arquivo de manifesto da biblioteca para abri-lo no editor de Manifesto RAS.
  3. Na página Recurso, exclua o texto padrão no campo Descrição Resumida e digite as informações que você deseja incluir para a biblioteca.
  4. Clique em Arquivo > Salvar Tudo para salvar as alterações.
  5. Na visualização Autoria de Padrões, clique com o botão direito do mouse na biblioteca do projeto e clique em Gerar Arquivos de Ajuda para incluir as informações de manifesto nos arquivos do projeto.
  6. Na visualização Explorador de Pacotes, expanda o nó PatternHelp sob PatternFiles e dê um clique duplo no arquivo HTML da biblioteca. Você pode visualizar as alterações feitas no arquivo.
Nota: É possível modificar propriedades adicionais do manifesto de biblioteca, utilizando o editor de Manifesto RAS, mas tenha cuidado. Os projetos de padrão dependem da integridade dos arquivos de manifesto da biblioteca e do padrão para construir e importar plug-ins de padrão.
Conceitos relacionados
Padrões de Design do IBM Rational
Código e Arquivos de Suporte de Padrões
Recursos de Padrão do RAS
Conteúdo do Projeto de Padrão
Tarefas relacionadas
Fornecendo Texto de Descrição Resumida
Incluindo Diagramas de Visão Geral
Gerando Arquivos de Documentação
Importando Documentação
Termos de uso | Feedback
(C) Copyright IBM Corporation 2004, 2005. Todos os Direitos Reservados.