2 ms·
Especially when at least right now one of the things being documented in the example as "first name of the user" is the last_name field! last_name | charact
by jsnell 11y ago
Especially when at least right now one of the things being documented in the example as "first name of the user" is the last_name field!
last_name | character varying(50) | ... | required first name of user
That shows two documentation antipatterns, actually. Documentation that conflicts with the code, and documentation so generic that it gets carelessly filled in with copy-paste.
- cmdkeen 11y agoI work with Oracle these days, or the ... might contain it - but is it not also missing a NOT NULL constraint? Documentation that conflicts with the DDL makes for an easy code review at least. I look at it more like an interface specification, especially as there are several ways to write DDL - though there should really be a house style. For instance the NOT NULL constraint might be being added later on the script, so it isn't necessarily readable in the same way as normal code.