Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.
Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.
Lost your password? Please enter your email address. You will receive a link and will create a new password via email.
Please briefly explain why you feel this question should be reported.
Please briefly explain why you feel this answer should be reported.
Please briefly explain why you feel this user should be reported.
How do you guys comment/document your .sql files?
Are there conventions similar to those of javadoc and the likes?
What is commonly done in large scale database-heavy applications like facebook, twitter, google….
There are no commenting conventions for SQL like Javadoc that I’ve seen. This would be a great question to pose to the Doxygen people though.
On the other hand, several RDBMS allow this:
This is more in keeping with the whole RDBMS philosophy – it’s all about data.
I don’t know of any system that will generate nice documentation with this though. Also, I don’t think this is standard yet.
I don’t think MySQL does comments this way but Oracle and PostgreSQL do.