C# Documentando código em XML Sharp Shooters.NET Universidade Federal de Pernambuco Centro de Informática Recife, 10/10/2002 Autor: Marden Menezes Costa.

Apresentação em tema: "C# Documentando código em XML Sharp Shooters.NET Universidade Federal de Pernambuco Centro de Informática Recife, 10/10/2002 Autor: Marden Menezes Costa."— Transcrição da apresentação:

1 C# Documentando código em XML Sharp Shooters.NET Universidade Federal de Pernambuco Centro de Informática Recife, 10/10/2002 Autor: Marden Menezes Costa

2 Introdução a XML Extensible Markup Language Linguagem de Marcação utiliza tags, assim como HTML novas tags podem ser criadas HTML é subconjunto de XML

3 REGRAS PARA TRABALHAR COM TAGS: As tags devem ter marcador de início e fim: conteúdo Exemplo: Microsoft Um par de tags é chamada elemento; Elementos podem conter dados ou outros elementos Um arquivo XML deve conter elementos com o par. Caso contrário o documento será considerado inválido; Introdução a XML

4 Tags vazias (sem conteúdo) podem ser escritas: Observe o fechamento com /> Um elemento pode conter atributos, que têm nome e valor, escritos entre aspas: XML é sensível ao contexto, logo a palavra TAG é diferente de tag

5 Introdução a XML Vamos mostrar agora um código em XML para que possamos discutí-lo, observe a semelhança com HTML: Mariquinha Rua Canario, 33 2233-0997 18/02/1980 José Al das Rosas, 443 9987-0986 23/04/1972

6 O código acima poderia ser escrito com elementos vazios e atributos: <Pessoas Nome = Mariquinha Endereco = Rua Canario, 33 Telefone = 2233-0997 Nascimento = 18/02/1980 /> <Pessoas Nome = José Endereco = Al das Rosas, 443 Telefone = 9987-0986 Nascimento = 23/04/1972 /> Introdução a XML

7 Arquivos de texto formatados (assim como HTML); Documentação do código em C# (assim como o javadoc em JAVA); Transmissão de dados entre programas Web-Services SOAP Utilização de XML

8 Tags para documentar código em C#

9

10 Documentando um código em C# Para que o comentário forme um documento XML, devemos utilizar /// antes do comentário: using System; namespace ComentarioXML { /// Classe Class1 /// Descrição da classe class Class1 { /// /// Este é um método público /// /// Parâmetro do tipo String /// retorna um inteiro /// Para chamar este método use a sintaxe: /// variavel = metodo(5) /// public int metodo(String s) { /* comandos */ }

11 Documentando um código em C# /// /// Descrição do método Main() /// /// Array de strings para /// armazenar os parâmetros da linha de /// comando /// /// O método Main() retorna /// um valor inteiro igual a 1 ou 0 static int Main (string[] args) { // comandos }

12 Gerando XML no Visual Studio.NET 1)Ir até a barra do Solution Explorer e selecionar o projeto atual; 2)Ir em Project na barra de Menu, abrirá uma janela. Clique na opção Configuration Properties e depois em build. Veja a tela a seguir: 3)Nas opções do menu à direita, procure por Outputs, onde estará um campo com o nome de XML Documentantion File. Nesse campo, digite o nome do arquivo XML onde serão salvos seus comentários;

13 Gerando XML no Visual Studio.NET

14 4)Para visualizar o arquivo XML sem as tags, vá em Tools, Build Comment Web Pages... No próximo slide vemos o resultado do comentário do método main, que é mostrado após ser escolhido no próprio XML da Class1:

15 Gerando XML no Visual Studio.NET

16 XML não serve apenas para codificar C#. Um dos mais importantes serviços que XML faz é trabalhando com dados. Na próxima reunião será discutido esse assunto de muita importância. Referências: C# e.NET - Guia do Desenvolvedor, ed. Campus, 2002 Introdução ao XML, na coluna Falando C# de Mauro Santanna no site www.microsoft.com.br Tutoriais de XML obtidos na internet Help do Microsoft ® Visual Studio.NET®