Estoy creando una BD en PostgreSQL y tengo la duda si vale la penan poner comentarios en los DDL de las tablas y las filas para generar documentación. No he visto que eso se use en la vida real. Quería saber si usted lo recomienda. Gracias
Se pierde muy poco tiempo haciendo
COMMENT ON TABLE foo IS 'whatever foo is';
COMMENT ON COLUMN foo.field IS 'whatever this field holds';
COMMENT ON INDEX foo_idx IS 'makes things fast';
COMMENT ON VIEW v_foo IS 'mirame a foo, ¿ah?';
COMMENT ON FUNCTION f_foo() IS 'foonciona';
y luego poder consultarla con `psql` (\d+, \df+, etc.) o `pgadmin`. Más aún, `postgresql-autodoc` es capaz de generar documentación HTML y diagramas en base a la información que está en la base de datos.
Esta es la flojera que funciona en la vida real. La otra, la de no escribir comentarios, es la que hace perder tiempo tratando de averiguar qué es cada cosa, y no te deja tener vida real.
Cuando las cosas no son obvias, tienes que documentarlas. Cuando crees que las cosas son obvias, usualmente estás equivocado, incluso cuando es obvio que sabes lo que estás haciendo. Definitivamente prefiero gente que es capaz de documentar por convicción y no por compromiso.
COMMENT ON TABLE foo IS 'whatever foo is';
COMMENT ON COLUMN foo.field IS 'whatever this field holds';
COMMENT ON INDEX foo_idx IS 'makes things fast';
COMMENT ON VIEW v_foo IS 'mirame a foo, ¿ah?';
COMMENT ON FUNCTION f_foo() IS 'foonciona';
y luego poder consultarla con `psql` (\d+, \df+, etc.) o `pgadmin`. Más aún, `postgresql-autodoc` es capaz de generar documentación HTML y diagramas en base a la información que está en la base de datos.
Esta es la flojera que funciona en la vida real. La otra, la de no escribir comentarios, es la que hace perder tiempo tratando de averiguar qué es cada cosa, y no te deja tener vida real.
Cuando las cosas no son obvias, tienes que documentarlas. Cuando crees que las cosas son obvias, usualmente estás equivocado, incluso cuando es obvio que sabes lo que estás haciendo. Definitivamente prefiero gente que es capaz de documentar por convicción y no por compromiso.