Skip to content

Commit

Permalink
docs: updated README to reflect actual implementation
Browse files Browse the repository at this point in the history
The explanation of comment blocks in tre README didn't match the actual
implementation, it now does.
  • Loading branch information
quintesse committed Jul 3, 2024
1 parent c360eba commit 256287d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,18 +103,18 @@ p.getComment("port") // Returns ["# Port number to", "# use for the server"]
### Comments

Just like with the original `Properties` implementation, lines starting with a
`#` or a `!` are considered comments. Consecutive comments lines that start
with the same comment character and have no other lines in between (not even
empty lines) are considered a single multi-line comment.
`#` or a `!` are considered comments. Consecutive comments lines (even the ones
that start with another comment character) and have no other lines in between
(not even empty lines) are considered a single multi-line comment.

```properties
# A single comment line

! A multi-line comment
! spanning two lines

# This is actually a single comment line
! And this is a single comment line too
# This is also a multi-line comment
! but using different comment chars
two=Second value
```

Expand Down

0 comments on commit 256287d

Please sign in to comment.