Changes between Version 28 and Version 29 of TracDev/CodingStyle

Timestamp:

Dec 16, 2015, 12:51:11 PM (8 years ago)

Author:

figaro

Comment:

Added SQL coding conventions

TracDev/CodingStyle

@@ -50 +50 @@
  * Avoid using `except Exception`, instead making the exception clause as narrow as necessary to catch the excepted exception.
 
-== JavaScript
+== Javascript
 
-!JavaScript code should follow [http://javascript.crockford.com/code.html these conventions] with the following exceptions and additions:
+Javascript code should follow [http://javascript.crockford.com/code.html these conventions] with the following exceptions and additions:
 * Lines shouldn't exceed a length of 79 characters.
 * Use two spaces for indentation and refrain from using tabs.
@@ -67 +67 @@
 * Omit the curly braces for variables in Genshi templates, using `$var` rather than `${var}`.
 
+== SQL
+
+While the Python and Javascript coding conventions differ from the SQL coding conventions, it is still important that we have them for code consistency and code legibility. Both of these make SQL code maintenance easier.
+* Table and column names are singular and lowercase.
+* Separate by underscore: `milestone_name` instead of `milestonename`.
+* Reserved words are uppercase: `SELECT` instead of `select`, `INTEGER` instead of `integer`.
+* Avoid abbreviations and if you have to use them make sure they are commonly understood.
+* Do not prefix with `tbl` or any other prefix or Hungarian notation.
+* Do not give a table the same name as one of its columns and vice versa.
+
+When presenting SQL code in the wiki, use the #sql preprocessor, as in `{{{!#sql`, so that the code highlights neatly.
+
 ----
 See also: TracDev