Developer criticism grows over JSON's lack of comment support in config files
A developer commentary questions why so many software tools rely on JSON for configuration files despite JSON's inability to natively support comments. The piece argues this makes it difficult for users to document why specific settings were chosen, a basic need in configuration management.
GoKawiil's interpretation of the reporting above, not reported fact.
Configuration files often outlive their original authors' memory of why settings were chosen, and the inability to annotate them can lead to confusion, accidental misconfigurations, or wasted time deciphering intent. This reflects a broader tension in tooling design between strict, machine-parseable formats and human-friendly documentation needs.
- JSON's spec excludes comments, limiting inline documentation of settings
- Many popular developer tools still default to JSON for configuration
- Alternatives like YAML or JSON5 support comments but are less universally adopted
The Pragmatic Programmer: 20th Anniversary Edition — If you've ever stared at a comment-less JSON config wondering why a flag was flipped, this classic is the nudge developers need about documenting intent and leaving good tracks for the next person. It's packed with practical habits around code, configuration, and communication that outlive whatever format your tool insists on. A great desk companion for anyone who maintains other people's settings files.
See The Pragmatic Programmer: 20th Anniversary Edition on Amazon → Affiliate link — we may earn a commission on purchases, at no extra cost to you. Product picked by AI based on this article; it is not a tested recommendation.Source: textlog.cc, 2026-09-02
Published there as: “Why do so many tools have JSON config files?”
Read the original report → The summary and analysis above are GoKawiil's own, written from reporting by the source above. Facts and quotes belong to the original publisher.