Publicado por Rafael Rosa em 11 de January de 2010

HOWTO – Tutorial sobre RDoc por Nando Vieira

howto-documentando-projetos-com-rdocNando Vieira, rubista de longa data na comunidade brasileira, autor de vários projetos open-source (página no GitHub) e do blog Simples Idéias, vêm escrevendo uma série de PDFs com tutoriais sobre vários assuntos relacionados à Ruby e Rails e os tem publicado numa série chamada HOWTO, como já divulgamos anteriormente, e hoje ele publicou o "Documentando Projetos com RDoc", que você pode baixar gratuitamente.

Nesse howto ele explica como você pode utilizar o RDoc, que faz parte da biblioteca padrão do Ruby, para comentar seu código e gerar documentação automaticamente. A maior parte da documentação oficial do Ruby, Rails e das gems que utilizamos no dia-a-dia são geradas com ele. Usando um texto simples, claro e objetivo, com muitos exemplos, a série howto é um excelente modo de se aprender mais uma técnica do Ruby.

Além do tutorial sobre RDoc, o Nando publicou outros tutoriais muito interessantes, como o "Rails Application Templates", que também é gratuito e explica como utilizar melhor o recurso de templating de projetos adicionado no Rails 2.3, e "O que mudou no Ruby 1.9", que custa apenas R$ 10, e vale a pena para você ter uma boa referência sobre o que mudou do Ruby 1.8 para o 1.9, vale uma olhada.

Deixe um Comentário