diff --git a/SC1127.md b/SC1127.md new file mode 100644 index 0000000..0fa2af1 --- /dev/null +++ b/SC1127.md @@ -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. \ No newline at end of file