Exemplo de documentação XML

Artigo
08/25/2010

Esse exemplo mostra como usar XML para o código do documento.Para obter mais informações, consulte Comentários de documentação XML (Guia de programação C#).

Para obter Zoom, Para Cima e Ampliar e instruções para instalá-los

Siga um ou mais destes procedimentos:
- Sobre o Help menu, Zoom, Para Cima e Ampliar Exemplos.
  
  O arquivo Leiame exibe informações sobre exemplos.
- Visite o O Visual Studio 2008 Zoom, Para Cima e Ampliar Zoom, Para Cima e Ampliar site. As versões mais recentes dos exemplos estarão disponíveis nele.
- Localize Zoom, Para Cima e Ampliar no computador em que Visual Studio está instalado. Por padrão, Zoom, Para Cima e Ampliar e um arquivo Leiame são instalados em unidade: \Arquivos de programas\Microsoft visual Studio 9.0\Zoom, Para Cima e Ampliar\LCID. Para edições Express do Visual Studio, todos os exemplos estão localizados on-line.

Para obter mais informações, consulte Localizando arquivos de exemplo.

Observação de segurança:
Esse código de exemplo é destinado a ilustrar um conceito, e ele mostra somente o código que é relevante para esse conceito. Ele pode não atender aos requisitos de segurança de um ambiente específico e não deve ser usado exatamente como mostrado. Recomendamos que você adicione código de segurança e tratamento de erros para tornar seus projetos tão seguros e robustos quanto for conveniente. A Microsoft fornece esse código de exemplo "Zoom, Para Cima e Ampliar encontra" sem garantias.

Esse código de exemplo é destinado a ilustrar um conceito, e ele mostra somente o código que é relevante para esse conceito. Ele pode não atender aos requisitos de segurança de um ambiente específico e não deve ser usado exatamente como mostrado. Recomendamos que você adicione código de segurança e tratamento de erros para tornar seus projetos tão seguros e robustos quanto for conveniente. A Microsoft fornece esse código de exemplo "Zoom, Para Cima e Ampliar encontra" sem garantias.

Para compilação a amostra de documentação XML no Visual Studio

In O gerenciador de soluções, clicar com o botão direito do mouse no projeto e, em seguida, clique em Propriedades.
Abra a pasta configuração Properties e, em seguida, clicar Compilação.
Defina a propriedade XML documentation arquivo para XMLsample.xml.
Sobre o Compilação menu, clicar Compilação.

O arquivo de saída XML será no diretório de depurar.

Para compilação a amostra de documentação XML em um aviso de comando

Para gerar a documentação XML de exemplo, digite o seguinte em um aviso de comando:
```
csc XMLsample.cs /doc:XMLsample.xml
```
Para ver o XML gerado, digite o seguinte comando:
```
type XMLsample.xml
```

Consulte também

Tarefas

Como: Usar os recursos de documentação XML (Guia de programação C#)

Conceitos

Exemplos no Visual C#

Guia de Programação C#