DEV Community

loading...

How to post json with comments?

Galdin Raphael
Software developer. When not writing code, I'm probably reading a book, playing the piano or studying music theory.
・1 min read

Using a json codeblock expects strictly valid JSON:

{
  "Email": { // <-- settings grouped under "Email"
    "ClientKey": "xxx",
    "ClientSecret": "xxx"
  }
}
Enter fullscreen mode Exit fullscreen mode

I tried jsonc and json5, both don't seem to be supported. Anyway to get dev.to to play nice with commented json without marking it as javascript?

Discussion (3)

Collapse
isherwood profile image
Clint Buhs • Edited

It's not a spiffy solution, but you might just have to add keys to your object just for the purpose of commenting and prefix the values with double slashes. My only other thought is to use multiple code blocks, alternating between json and js as needed.

Collapse
hieunv1996 profile image
Nguyễn Văn Hiếu

You can comment in json like this:

{
  "Email": {
    "Comment": "settings grouped under \"Email\""
    "ClientKey": "xxx",
    "ClientSecret": "xxx"
  }
}
Collapse
ben profile image
Ben Halpern

javascript?