mirror/sqlstyle.guide
1
0
Fork 0
mirror of https://github.com/treffynnon/sqlstyle.guide.git synced 2025-03-09 12:49:51 -05:00
Code Activity

Moved comment examples

Browse source 
Hi - I believe these comment examples should be directly under the comment bullet in the Do. Thanks :)
This commit is contained in:
Dave Lyons 2016-05-16 09:57:32 -04:00
parent a67f5fe8f1
commit 0197120571
1 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
_includes/sqlstyle.guide.md
View file

@ -36,18 +36,6 @@ Based on a work at [http://www.sqlstyle.guide][self].
closing `*/` where possible otherwise preceed comments with `--` and finish closing `*/` where possible otherwise preceed comments with `--` and finish
them with a new line. them with a new line.
### Avoid
* CamelCase—it is difficult to scan quickly.
* Descriptive prefixes or Hungarian notation such as `sp_` or `tbl`.
* Plurals—use the more natural collective term where possible instead. For example
`staff` instead of `employees` or `people` instead of `individuals`.
* Quoted identifiers—if you must use them then stick to SQL92 double quotes for
portability (you may need to configure your SQL server to support this depending
on vendor).
* Object oriented design principles should not be applied to SQL or database
structures.
```sql ```sql
SELECT file_hash -- stored ssdeep hash SELECT file_hash -- stored ssdeep hash
FROM file_system FROM file_system
@ -61,6 +49,18 @@ UPDATE file_system
WHERE file_name = '.vimrc'; WHERE file_name = '.vimrc';
``` ```
### Avoid
* CamelCase—it is difficult to scan quickly.
* Descriptive prefixes or Hungarian notation such as `sp_` or `tbl`.
* Plurals—use the more natural collective term where possible instead. For example
`staff` instead of `employees` or `people` instead of `individuals`.
* Quoted identifiers—if you must use them then stick to SQL92 double quotes for
portability (you may need to configure your SQL server to support this depending
on vendor).
* Object oriented design principles should not be applied to SQL or database
structures.
## Naming conventions ## Naming conventions
### General ### General