come faccio a elaborare un file readme con rdoc alla visualizzazione ruby script di aiuto / info utilizzo
https://stackoverflow.com/questions/4215536
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianDomanda
Mi piacerebbe mantenere il mio utilizzo documenation in un file readme (duh), invece di commenti nella parte superiore del mio script. Come faccio ad avere RDoc :: utilizzo di tirare le informazioni sull'utilizzo fuori del readme al posto dei commenti di script?
Soluzione
RDoc è stato progettato per analizzare un file sorgente, un'occhiata ai commenti e le loro posizioni, creare riferimenti incrociati delle variabili, e, una volta fatto, legare il tutto in un'uscita decente. Perché RDoc è stato progettato per lavorare contro i file di origine potrebbe non essere la scelta migliore per ciò che si vuole fare.
Invece si potrebbe voler esaminare Yard , che è basato su tag. Posso ottenere il mio README.textile nel mio RDoc e formattata? ha alcune informazioni utili anche per te.
In entrambi i casi, se non è possibile ottenere l'applicazione per analizzare un file README di tipo doc come si vuole, si potrebbe essere in grado di spoofing che mettendo tutti i tuoi documenti nel file, insieme con mozziconi di classe e il metodo in modo parser possono afferrare i parametri, globali, e altri "quant'altro" di cui hanno bisogno per creare documentazione utilizzabile.
In caso contrario, probabilmente dovrete rinunciare utilizzando l'aiuto automatico e digitare tutto in.
La mia raccomandazione è quella di farlo nel modo RDoc, e il documento all'interno del vostro codice. Non è difficile da fare a tutti, e l'uscita può essere molto soddisfacente. E 'piuttosto sorprendente quanto bene un RDoc lavoro può fare.
Altri suggerimenti
Non sono certamente abbastanza esperienza per dire la risposta, ma mi permetta un consiglio.
La maggior parte degli sviluppatori è improbabile per aggiornare sempre la documentazione, anche se si tratta di 3 linee di codice di cui sopra l'implementazione.
Fare un favore e non rendere il processo ancora più difficile.
di gestione della documentazione generale separata è una bella idea, però, ma non ha nulla a che fare nella vostra uscita RDoc generati in ogni caso.
