Skip to content

Commit

Permalink
Moved comment examples
Browse files Browse the repository at this point in the history
Hi - I believe these comment examples should be directly under the comment bullet in the Do. Thanks :)
  • Loading branch information
dmlyons2 committed May 16, 2016
1 parent a67f5fe commit 0197120
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions _includes/sqlstyle.guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,6 @@ Based on a work at [http://www.sqlstyle.guide][self].
closing `*/` where possible otherwise preceed comments with `--` and finish
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
SELECT file_hash -- stored ssdeep hash
FROM file_system
Expand All @@ -61,6 +49,18 @@ UPDATE file_system
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

### General
Expand Down

0 comments on commit 0197120

Please sign in to comment.