código fonte Keeping sustentável é um dos desafios mais difíceis que qualquer desenvolvedor de software , seja um programador lobo solitário ou um membro de uma grande equipe . Doxygen permite gerar documentação automaticamente a partir de C + + , Java, ou outro código . Ele irá analisar o seu código não documentado e escrever documentação básica , e você pode adicionar comentários especialmente formatados para o seu código fonte para fazer adições úteis para o código-fonte gerado. Coisas que você precisa
código fonte
Editor de Texto
Show Mais instruções
1

Baixe e instale o Doxygen . Ele está disponível em stack.nl /~ dimitri /doxygen /download.html # latestsrc .
2

Abra um prompt de comando . No Windows XP, você pode fazer isso clicando no menu Iniciar , escolha Executar , digitar "cmd" , e clicar em OK. No Mac OS, você pode clicar no menu do Spotlight , o tipo de terminal, e escolha Terminal quando ela aparece. Navegue prompt de comando para o diretório do código-fonte , digitando " cd ", seguido do nome do diretório e pressionar Enter.
3

Criar um Doxyfile digitando " doxygen - g" e pressionando Enter. Isso irá gerar um arquivo no diretório atual chamado " Doxyfile ", que irá conter todas as opções Doxygen padrão. Você pode modificar essas opções , abrindo o Doxyfile em um editor de texto.
4

Adicione comentários Doxygen ao seu código -fonte. Comentários Doxygen são comentários normais que contêm anotações especiais que permitem Doxygen para encontrá-los e indicar como deve usá-los. Por exemplo, se você está escrevendo em uma linguagem de estilo C , você pode adicionar uma breve descrição de uma função , adicionando o seguinte comentário antes de sua declaração :/* ! \\ informar minha descrição breve * /Você pode ver todas as outras anotações Doxygen suporta a stack.nl /~ dimitri /doxygen /docblocks.html .
5

Type " doxygen Doxyfile " no seu prompt de comando e pressione Enter. Isso irá gerar a documentação do seu código fonte.