Skip to content

Commit

Permalink
update readme settings for JSON semantics (#77)
Browse files Browse the repository at this point in the history
* update readme settings for JSON semantics

The settings in the current readme.md are semantically incorrect when pasting into VS Code. Updated to correct JSON semantics.

* Fix spacing and weird strikethrough tag that appeared
  • Loading branch information
blakewilson authored and aaron-bond committed Jun 10, 2018
1 parent 062188d commit 71f9019
Showing 1 changed file with 35 additions and 29 deletions.
64 changes: 35 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,44 +16,50 @@ With this extension, you will be able to categorise your annotations into:
This extension can be configured in User Settings or Workspace settings.


`'better-comments.multilineComments': true`
`"better-comments.multilineComments": true`
This setting will control whether multiline comments are styled using the annotation tags.
When false, multiline comments will be presented without decoration.

`'better-comments.highlightPlainText': false`
`"better-comments.highlightPlainText": false`
This setting will control whether comments in a plain text file are styled using the annotation tags.
When true, the tags (defaults: `! * ? //`) will be detected if they're the first character on a line.

`better-comments.tags`
The tags are the characters or sequences used to mark a comment for decoration.
The default 5 can be modifed to change the colors, and more can be added.
```javascript
[{
`tag`: '!',
`color`: '#FF2D00',
`strikethrough`: false,
`backgroundColor`: 'transparent'
},{
`tag`: '?',
`color`: '#3498DB',
`strikethrough`: false,
`backgroundColor`: 'transparent'
},{
`tag`: '//',
`color`: '#474747',
`strikethrough`: true,
`backgroundColor`: 'transparent'
},{
`tag`: 'todo',
`color`: '#FF8C00',
`strikethrough`: false,
`backgroundColor`: 'transparent'
},{
`tag`: '*',
`color`: '#98C379',
`strikethrough`: false,
`backgroundColor`: 'transparent'
}]
```json
"better-comments.tags": [
{
"tag": "!",
"color": "#FF2D00",
"strikethrough": false,
"backgroundColor": "transparent"
},
{
"tag": "?",
"color": "#3498DB",
"strikethrough": false,
"backgroundColor": "transparent"
},
{
"tag": "//",
"color": "#474747",
"strikethrough": true,
"backgroundColor": "transparent"
},
{
"tag": "todo",
"color": "#FF8C00",
"strikethrough": false,
"backgroundColor": "transparent"
},
{
"tag": "*",
"color": "#98C379",
"strikethrough": false,
"backgroundColor": "transparent"
}
]
```

## Supported Languages
Expand Down

0 comments on commit 71f9019

Please sign in to comment.