Created SC1127 (markdown)

koalaman
2018-01-17 18:25:44 -08:00
parent 6fc60b6cad
commit 42cfcf764e

24
SC1127.md Normal file

@@ -0,0 +1,24 @@
## Was this intended as a comment? Use `#` in sh.
### Problematic code:
```C
// This is a comment.
/* This too. */
```
### Correct code:
```sh
# This is a comment.
# This too.
```
### Rationale:
ShellCheck found what appears to be a C-style comment, a line starting with `//` or `/*`.
In Bourne based shell scripts, the comment character is `#`
### Exceptions:
None.