Acabo de comenzar a documentar una aplicación de rieles. Sé que esto realmente lo hace rdoc, así que seguí algunas guías de rdoc con respecto a la sintaxis y demás, pero me quedé atascado cuando traté de describir los atributos de los modelos, las validaciones y la relación entre los modelos, principalmente porque estas cosas son parte de ActiveRecord. Entonces, me pregunto si hay alguna guía o una buena práctica sobre cómo documentar una aplicación de rieles o si me falta algo.¿Cómo documentar una aplicación de rieles?
Sé que podría poner todo esto en la descripción de la clase, pero me pregunto si hay una forma más estrechamente relacionada con la declaración en sí misma (has_muy, validates_presence_of, etc.) y ¿qué pasa con los atributos?
Creo que este es un enfoque muy iterativo, creo que el único problema es que parece un poco joven y tiene una curva de aprendizaje más pronunciada de lo que esperaba, sin embargo, creo que tiene un gran potencial. Incluso comencé a imaginar algunas características agradables, como alimentar la base de datos con la documentación de las migraciones, y luego obtener esa documentación en el generador, de esa manera puedes matar dos pájaros de un tiro, la documentación de la aplicación y la de la base de datos. – ramontiveros