Olá pessoal,
Iniciei a documentação do software que estou desenvolvendo em python. Há um tempo atrás, aqui no laboratório em que trabalho, descobriu-se uma ferramenta interessante, o Doxygen.
O Doxygen é “generator” de documentação. Ele funciona com diversas linguagem de programação, desde do Python até C++ e Java.
É necessário instalá-lo para usar, sendo que está disponível em sua página e também na SourceForge. É possível usá-lo em diversas plataformas.
Uma vantagem para quem usa o Ubuntu 7.04 é que ele já possui o pacote do doxygen, basta ir na linha de comando e escrever:
sudo apt-get install doxygen
Para que ele gere corretamente a documentação, você deve usar uma forma padronizada de comentário. Vários são os formatos da documentação que ele gera, desde html até latex ou pdf.
Para quem estiver curioso, aqui vai um exemplo de um software documentado com o Doxygen: www.lsi.usp.br/nate/documentation/oficina-doc.
Para mais informações sobre o Doxygen acesse: www.stack.nl/~dimitri/doxygen/.
Espero que tenham gostado da dica!
Ola nathy desculpa esta comentando aqui isso, sei que nao tem nada have… mas estava pesquisando sobre como desenvolver para o olpc e vi seu nome no time de desenvolvedores, acabei entrando no seu blog para ver se tinha o seu email e infelismente nao… gostaria de saber cara como eu poderia aprender, para comecar a ajudar a desenvolver… gostei muito da filosofia do OLPC e gostaria de ter ajuda para achar um NORTE… =)
aguardo contato… meu email é
mbsalgueiro@linuxmail.org
abracao e obrigado