YAML(YAML Ain't Markup Language)文件格式具有以下一些主要的要求和特点:
-
缩进表示层级结构
- 使用空格进行缩进,通常是 2 个或 4 个空格,但整个文件中缩进的空格数量应保持一致。
- 缩进的程度决定了元素的层级关系。
-
键值对
- 键和值之间用冒号
:
分隔,例如:key: value
- 值可以是字符串、数字、布尔值、列表、字典等。
- 键和值之间用冒号
-
字符串
- 可以使用单引号
'
或双引号"
括起来,也可以不使用引号,但如果字符串中包含特殊字符,建议使用引号。
- 可以使用单引号
-
数字
- 直接书写,例如:
123
、3.14
等。
- 直接书写,例如:
-
布尔值
- 用
true
和false
表示。
- 用
-
列表
- 用
-
开头表示列表项,例如:
- 用
yaml
- item1
- item2
- item3
或者
yaml
list:
- item1
- item2
- item3
- 字典
- 以键值对的形式表示,例如:
yaml
person:
name: John
age: 30
-
注释
- 使用
#
开头表示注释,注释内容直到行尾。
- 使用
-
多行字符串
- 可以使用
|
或>
符号来表示多行字符串。 |
会保留字符串中的换行和缩进。>
会将字符串折叠成一行,去掉多余的换行和缩进。
- 可以使用
例如:
yaml
# 这是一个注释
name: Alice
age: 25
hobbies:
- Reading
- Painting
- Traveling
description: |
This is a long description
that spans multiple lines
with preserved indentation.
在编写 YAML 文件时,遵循这些规则可以确保文件的格式正确和易于理解。