Comment on What is the best file format for configuration file?

{
  comment: "This data is super important and it runs the system or something",
  data: ["Some", "stuff", "here"]
}

• noli@programming.dev ⁨1⁩ ⁨year⁩ ago

  You disgust me

  source
• sfera@beehaw.org ⁨11⁩ ⁨months⁩ ago

  How do you comment multiple properties separately?

  source

  • AeroLemming@lemm.ee ⁨11⁩ ⁨months⁩ ago

    Please don’t actually do this. Comment stuff in the code and documentation, not the JSON.

    source

    • sfera@beehaw.org ⁨11⁩ ⁨months⁩ ago

      Don’t worry, I wouldn’t do things like this in JSON. Nevertheless, it can be very useful to have comments along with configuration values, for example to explain the actual values (not their purpose) and why they were chosen. That’s information you can’t add to the code which processes the values.

      source
• simonced@lemmy.one ⁨1⁩ ⁨year⁩ ago

  This is actually pretty genius, why haven’t ever thought of that?

  source

  • AeroLemming@lemm.ee ⁨1⁩ ⁨year⁩ ago

    It’s so easy to use, and you can read the comments from in your program too!

    ^(in case you weren’t just playing along, please never do comments this way)

    source

    • simonced@lemmy.one ⁨1⁩ ⁨year⁩ ago

      I liked the idea to be honest. I can just call the entry “description” instead and all is good ^^

      source

      • AeroLemming@lemm.ee ⁨1⁩ ⁨year⁩ ago

        Ideally, you would use TOML for human-readable configuration and document your JSON API with external documentation instead of sending comments around a bunch. If you need to display the description to the end user though, that would be a valid use case.

        source