Documentation
Documentation is essential for developers, as well as business owners, to understand the full picture. Documentation for the database schema, objects, and code should be maintained. ER and class diagrams are very useful in understanding the full picture. There are tons of programs that support UML and ER diagrams. You can generate ER and UML diagrams by using graph-editing tools, such as yEd, or an online tool, such as draw.io. Also, there are many commercial UML modeling tools that support reverse-engineering code.
Code documentation provides an insight into complex SQL statements. PostgreSQL uses -- and /**/ for single-line and multiline comments, respectively. The single-line comment, --, works on the rest of the line after ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access