# 注释与存储

最后,我们来了解JSON的注释与文件存储。

# 注释

注释Comment)是代码文件中为了阐明上下文信息而写入的一段文本,有效的注释可以使阅读代码变得更加高效。标准的JSON规范是不支持注释的,但是**《我的世界》中的JSON全部都支持注释**。注释可以通过两种方式实现,分别是单行注释Single-line Comment)和多行注释Multi-line Comment)。

# 单行注释

我们可以使用连续的两个英文正斜杠//来开启一个单行注释,从//之后的所有部分都将属于注释的内容,不会被当做JSON的正文被计算机解析。以下是一个运用了单行注释的JSON示例:

// 小明的个人信息
{
    "name": "小明", // 姓名
    "height": 170, // 身高
    "weight": 60 // 体重
}

# 多行注释

单行注释虽然应用起来非常方便,但是还是有诸多限制,例如,单行注释开始之后就必须遇到换行符才能结束注释,并不能通过我们的自由意志来控制何时结束,亦或者,单行注释只能在同一行中进行注释,如果我们想书写一些跨行文本作为注释,就必须在每一行前面都写入两个英文正斜杠//,这显得十分冗余。所以,应对上述举例中的情形,我们更愿意使用多行注释来解决问题。

多行注释以连续的一个英文正斜杠和一个星号/*开始,以连续的一个星号和一个英文正斜*/结束,其中间所有内容皆属于注释内容,不会被计算机解析,示例如下:

/* 小明的个人信息
包含了姓名、身高、体重等信息
内部数据,不可外传 */
{
    "name": "小明", // 姓名
    "height": 170, // 身高
    "weight": 60 // 体重
}

善用注释,既可以方便自己在后期对代码进行调试,也方便他人对代码进行快速阅读和理解。

# 文件

虽然之前介绍过JSON编辑工具,但我们还没有学习如何将JSON保存为一个文件。事实上,JSON保存为文件非常简单,虽然JSON文件的文件扩展名为.json,但其事实上就是一个纯文本文件(你可以理解为扩展名为.json的TXT文件)。整个文件以左花括号(或左方括号)开始,以右花括号(或右方括号)结束,包含了一整个JSON对象(或数组),这便是一个JSON文件。额外地,JSON文件的MIME类型是“application/json”。

正确且熟练地编辑JSON文件是《我的世界》附加包学习和开发的基础,请开发者们谨记本节学习到的内容,练习并熟练地应用到附加包开发的过程中。

注释

单行注释

多行注释

文件