From e5236511010c670e7545dd55833bae98c9fcd858 Mon Sep 17 00:00:00 2001
From: Tiago Cardoso <tiagocardoso.dev@gmail.com>
Date: Thu, 5 Oct 2023 12:13:44 -0300
Subject: [PATCH] feat: adding jsdoc-style settings in readme (#79)

* Adding JSDoc-style to tokyo-night

* Fixing JSDoc-style

* reverting theme changes

* adding jsdoc highlight settings in readme

---------

Co-authored-by: Tiago Silva Cardoso - 06453943514 <tiago.s.cardoso@animaeducacao.com.br>
---
 README.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/README.md b/README.md
index d2cbe47..ac48581 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,49 @@ Paste this into your [settings.json](https://code.visualstudio.com/docs/getstart
     }
 }
 ```
+## Enabling JSDoc Highlights
+Paste this into your [settings.json](https://code.visualstudio.com/docs/getstarted/settings#_settings-file-locations) to Enable JSDoc Highlight.
+
+```javascript
+"editor.tokenColorCustomizations": {
+    "[Tokyo Night]": { // or "[Tokyo Night Storm]"
+        "textMateRules": [
+        {
+            "scope": [
+                "comment keyword.codetag.notation",
+                "comment.block.documentation keyword",
+                "comment.block.documentation storage.type.class"
+            ],
+            "settings": {
+                "foreground": "#bb9af7"
+            }
+        },
+        {
+            "scope": ["comment.block.documentation entity.name.type.instance"],
+            "settings": {
+                "foreground": "#73daca",
+                "fontStyle": "italic"
+            }
+        },
+        {
+            "scope": [
+            "comment.block.documentation entity.name.type punctuation.definition.bracket"
+            ],
+            "settings": {
+                "foreground": "#bb9af7"
+            }
+        },
+        {
+            "scope": ["comment.block.documentation variable"],
+            "settings": {
+                "foreground": "#e0af68",
+                "fontStyle": "italic"
+            }
+        }
+        ]
+    }
+  }
+```
 ## Customization Settings Examples
 #### Higher Contrast Settings
 The below can by no means officially represent high contrast but they may serve as a starting point. This assumes that the darker Tokyo Night version is being used.