Desidero creare documenti per i modelli e il controller della mia applicazione. Anche per attività rake, qualsiasi lavoro in background. Come ho migliaia di righe di commenti in linea tra il codice, spiegazione delle funzioni tutte le azioni ..Come generare documenti per i miei modelli e controller nei binari
non voglio docs per le rotaie in modo
rake doc:rails
è inutile per me.
Usecase è le note di sviluppo dettagliate interne.
Prova utilizzando questo compito rake:
rake doc:app
Questo compito è fornire da Rdoc e si può vedere un esempio di quel tipo di documentation here. Supporta anche alcuni markup che è possibile utilizzare per rendere le cose un aspetto migliore quando formattate e si può vedere alcuni examples here.
Impressionante ... C'è una terza parte plugins/gioiello disponibile per documentazioni migliori. Questo va bene, ma io amo ancora avere qualcosa di meglio di questo. –
Rdoc è la documentazione di base standard per Rails, puoi dare un'occhiata a ERD per i grafici o YARD http://yardoc.org/. –
I collegamenti RDoc sopra puntano a pagine SourceForge che non esistono più. La nuova casa per RDoc è su GitHub.
ironia è, io sono qui per cercare il comando di generare binari doc :) grazie mille – Anwar