JSON文件内容加注释的几种方法「建议收藏」

JSON文件内容加注释的几种方法「建议收藏」JSON规范,不支持注释。之所以不允许加注释,主要是防止:过多的注释,影响了文件本身的数据载体的目的。有些文件,尤其是配置文件,加入解释说明一些数据项的含义,是有必要的。1、使用JSON5规范JSON5规范允许在JSON文件中加入注释:单行注释,多行注释均可。2、直接用json-schema,使用规范中的注释字段优点:功能强大缺点:json-s…

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

JSON规范,不支持注释。之所以不允许加注释,主要是防止:过多的注释,影响了文件本身的数据载体的目的。

有些文件,尤其是配置文件,加入解释说明一些数据项的含义,是有必要的。

1、使用JSON5规范

     JSON5规范允许在JSON文件中加入注释:单行注释,多行注释均可。

2、直接用json-schema,使用规范中的注释字段

     优点:功能强大

     缺点:json-schema与json数据本身分离

3、使用去注释的库

     可以使用npm的strip-json-comments库。

4、使用约定的key作为注释字段

     如以”//”, “_comment”,”#####”(“#”个数自定) 作为注释的key等

5、使用重名key作为注释。

     即每个key,使用两次,第1次做注释,第2次做实际属性

6、使用字段key加前缀做注释key

     常用的前缀还有”#”, “_”, “__”等。

     优点:没有重名的字段,完全符合JSON协议。

7、使用支持注释的配置文件管理模块

     如npm中rc库(见:https://github.com/dominictarr/rc),

     或者config(见:https://github.com/lorenwest/node-config)

     缺点:只能用于配置相关的Json文件。使用方法需要依照模块的要求。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/183793.html原文链接:https://javaforall.net

(0)
上一篇 2022年8月31日 下午3:00
下一篇 2022年8月31日 下午3:16


相关推荐

  • 细说SDRAM控制器

    细说SDRAM控制器SDRAM的基本概念SDRAM凭借其极高的性价比,广泛应用于高速数据存储、实时图像处理等设计当中,但是相对于SRAM、FIFO等其他存储器件,SDRAM的控制相对复杂。虽说是复杂,但也不代表没办法实现,仔细梳理一下,发现SDRAM的控制其实也没这么难。本文就SDRAM的基本概念以及其工作流程做简要介绍。SDRAM的基本信号:SDRAM的基本信号(电源以及地线在这里不讨论)可以…

    2022年7月25日
    13
  • 记录搭建Hexo博客系统

    记录搭建Hexo博客系统

    2022年3月12日
    56
  • Python编程规范

    1,Python编程规范>编码>注释>缩进>空格空格在Python代码中是有意义的,因为Python的语法依赖于缩进,在行首的空格称为前导空格。在这一

    2022年3月29日
    51
  • HandlerThread原理分析、实战、最佳实践!

    HandlerThread原理分析、实战、最佳实践!本文我们将学习HandlerThread的实现原理,以及开发时,如何正确的使用它来实现我们的开发任务。HandlerThread源码分析设想这样一个场景:我们要在一个线程A中处理业务逻辑,在另一个线程B中,监听A的执行,并进行结果处理。这时我们使用HandlerThread就可以非常简单的实现该功能了。通常我们的线程交互场景,都是UI线程中启动子线程,并且由子线程完成工作任务,最终结果交给UI线程。现在我们的使用场景是,在子线程中监控其他线程的执行结果(这里的其他线程可以是另一个子线程,也可以是UI

    2025年7月15日
    9
  • Java volatile关键字作用

    Java volatile关键字作用当一个共享变量被volatile修饰时,它会保证修改的值立即被更新到主存“,这里的”保证“是如何做到的?和JIT的具体编译后的CPU指令相关吧?  volatile特性  内存可见性:通俗来说就是,线程A对一个volatile变量的修改,对于其它线程来说是可见的,即线程每次获取volatile变量的值都是最新的。  volatile的使用场景  通过关键字sychronize…

    2022年6月1日
    37
  • 【源力觉醒 创作者计划】文心开源大模型ERNIE-4.5私有化部署保姆级教程与多功能界面窗口部署

    【源力觉醒 创作者计划】文心开源大模型ERNIE-4.5私有化部署保姆级教程与多功能界面窗口部署

    2026年3月12日
    2

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号