Rdoc: documentazione automatica

Oltre alle caratteristiche di formattazione viste prima RDoc mette a disposizione una gran quantità di direttive molto avanzate. Rimando dunque alla documentazione ufficiale per maggiori dettagli e approfondimenti.

Tra le tante cose, RDoc viene incontro anche a tutti quegli sviluppatori che odiano scrivere la documentazione, fosse anche solo l'help in line. Infatti RDoc riesce a tirare fuori della documentazione utile in HTML anche da sorgenti privi di qualsiasi commento. Facciamo una prova, riprendiamo il nostro esempio nella versione senza commenti e vediamo RDoc cosa ci tira fuori.

class Veicolo
    attr_reader :carburante

    def initialize (carburante)
        @carburante = carburante
    end

    def rifornimento (quantita)
        @carburante += quantita 
    end
end

class CarroArmato < Veicolo
    attr_reader :colpi

    def initialize (carburante, colpi)
        super(carburante)
        @colpi = colpi
    end
end

class Camion < Veicolo
    attr_reader :posti

    def initialize (carburante, posti)
        super(carburante)
        @posti = posti
    end
end

Salviamo il codice pubblicato sopra nel file veicolo.rb ed eseguiamo rdoc:

$ rdoc veicolo.rb

                         veicolo.rb: c..c.c.
Generating HTML...

Files:   1
Classes: 3
Modules: 0
Methods: 4
Elapsed: 0.123s

In Figura 6 una pagina generata da RDoc, è il massimo che si può ottenere senza scrivere una riga di documentazione, ed è comunque utile per capire come sono strutturate le classi.

Figura 6: La documentazione automatica