Document comment syntax

Documented comment syntax and explicitly stated that trailing comments are not supported.
2018-06-20 20:58:59 +03:00 · 2018-06-20 20:58:59 +03:00 · 067bca6e58
commit 067bca6e58
parent 14e03613a0
1 changed files with 8 additions and 0 deletions
--- a/Documentation/Getting-Started/Configuration-Guide.md
+++ b/Documentation/Getting-Started/Configuration-Guide.md
@ -82,6 +82,14 @@ The values of the parameter that are not on the first line need to have at least
 one whitespace character before them in order for them to be recognized as a
 part of the multi-line parameter.

+Comments are defined by prefixing a row with a hash (`#`). Trailing comments are
+not supported.
+
+```
+# This is a comment before a parameter
+some_parameter=123
+```
+
 ### Special Parameter Types

 #### Sizes