Incluindo Documentação em Bibliotecas de Padrões

biblioteca padrão mantém informações sobre seus padrões membro em um arquivo de dados estático. Você pode incluir a documentação nesse arquivo de manifesto de biblioteca para ser utilizado pelo aplicador do padrão.
Antes de Iniciar
Por Que e Quando Desempenhar Esta Tarefa

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.
O que Fazer Depois
Tarefas relacionadas
Fornecendo Texto de Descrição Resumida
Incluindo Diagramas de Visão Geral de Padrão
Gerando Documentação da Biblioteca Padrão
Importando Documentação

Feedback