Ho appena iniziato a documentare un'applicazione di rotaie. So che questo è in realtà fatto da rdoc, quindi ho seguito alcune guide rdoc riguardo la sintassi e così via, ma mi sono bloccato quando ho provato a descrivere gli attributi di modelli, convalide e la relazione tra i modelli, principalmente perché queste cose fanno parte di ActiveRecord. Quindi mi chiedo se c'è qualche guida o una buona pratica su come documentare un'applicazione di rotaia o se c'è qualcosa che mi manca?Come documentare un'applicazione di rotaia?
So che potrei inserire tutto questo nella descrizione della classe, ma mi chiedo se c'è un modo più strettamente legato alla dichiarazione stessa (has_many, validates_presence_of, ecc.) E per quanto riguarda gli attributi?
Penso che questo sia un approccio molto iterestivo, penso che l'unico problema è che sembra ancora un po 'giovane e ha una curva di apprendimento più pronunciata di quanto mi aspettassi, tuttavia penso che abbia un po' di potenzialità. Ho persino iniziato ad immaginare alcune caratteristiche interessanti, come ad esempio alimentare il database con la documentazione delle migrazioni e quindi ottenere quella documentazione nel generatore, in questo modo è possibile uccidere due piccioni con una fava, la documentazione dell'applicazione e la documentazione del database. – ramontiveros