HOWTO: workshops e e-books para geeks.

Documentando projetos com RDoc

Veja como documentar seu projeto Ruby utilizando o RDoc, uma ferramenta que gera documentação à partir de seu código-fonte, sem a necessidade de usar marcações especiais ou sintaxes mais complicadas.

Um dos fatores mais importantes que pode influenciar a adoção de uma biblioteca em qualquer linguagem é, sem dúvida, a documentação. Quanto mais bem documentado, maior a chance de seu código ser utilizado por outros desenvolvedores. E a melhor maneira de se escrever a documentação é comentar o seu código-fonte e gerar documentos à partir dele. Existem diversas ferramentas para outras linguagens como PHPDoc e JavaDoc. No Ruby, temos o RDoc.

O RDoc é extremamente simples e gera a documentação à partir dos comentários de seu código-fonte, sem precisar de uma sintaxe específica. Ele é utilizado por quase todos os grandes projetos disponíveis em Ruby, como o Rails e RSpec.

E mesmo códigos-fonte já existentes podem se beneficiar do RDoc, já que ele irá gerar a documentação da API, com uma lista de módulos, classes e métodos, permitindo ter uma ideia maior do que sua biblioteca oferece.

Neste PDF você verá como utilizar o RDoc, para complementar ainda mais a documentação gerada por seus testes.

Download

Este e-book foi disponibilizado gratuitamente para download. Seja legal e envie um tweet!