O objetivo deste módulo é a aplicação das técnicas de refatoração de código com foco na geração de comentários para o melhor entendimento do sistema. Existem algumas situações onde é considerado boa pratica fazer comentarios especiais, como declarações de classes e variáveis. Além disso neste modulo foi aplicado o uso de ferramentas para a automatização na geração de documentação através de comentário em código.

Doxygen

  É a ferramenta padrão pelo De Facto Standard para geração de documentação atravéz de comentários em códigos em C++. Suporta também outra linguagens como Python, PHP e outras. Pode ser usado para:
- Gerar documentação navegavel em html
- Ver a estrura de um projeto ainda não documentado
- Gerar uma documentação tradicional

Elementos do Doxygen Incorporados

  A aplicação do padrão previsto pela ferramenta está documento na folha de estilo, disponivel Aqui

Cabeçalho de Arquivo

Cabeçalho de Classe

Cabeçalho de Função

Cabeçalho de Variavel

Comentar Linhas individuais

  

   Exemplo de código com comentário:

   Exemplo de código sem comentário:

Comentar parágrafos de código

  

   Exemplo de código com comentário:

   Exemplo de código sem comentário:

Comentar declaração de variáveis

  

   Exemplo de código com comentário:

   Exemplo de código sem comentário:

   Caso peculiar:

Comentar estruturas de controle

  

   Exemplo de código com comentário:

   Exemplo de código sem comentário:

Comentar Rotinas

  

   Exemplo de código com comentário:

   Exemplo de código sem comentário:

Comentar arquivos, classes e programas

  

   Exemplo de código com comentário:

   Exemplo de código sem comentário:

Utilização de cabeçalho de arquivo

  

   Exemplo:

Uso de Marcadores

  

   Exemplo:

   Doxygen - http://www.stack.nl/~dimitri/doxygen/index.html