YAML 评论
注释用于阻止语句的执行。编译器执行代码时会忽略注释。注释是用户友好的,因为用户可以使用注释获得代码的解释。
既然你对 YAML 的句子结构和基础知识没问题,让我们继续深入了解它的细节。在这一部分中,我们将了解如何在 YAML 中使用注释。注释用于描述关于代码生命周期的有意义的信息。
有两种评论。
- 内联或单行注释
- 块级注释
YAML 支持内联注释的语言结构,但不支持块级注释
内联注释:内联注释是在代码行中声明的注释,在行首使用 Hashtag 图像告诉处理器它是注释。
例子:
# remarks Punctuation model in YAML document
or
#### #### comment model
这些只是确定为单行注释。每行评论都以标签图像和清晰的空间开头,然后是描述。每行以换行符结束。
块级注释:方形注释用于注释各行。 YAML 对块评论自然没有帮助,你可以利用大量的内联评论
# block level Comment model
# Comment line 1
# Comment line 2
# Comment line 3
YAML 中注释的重要注释:注释被 yaml 处理器忽略。有助于报告代码行,使设计师的生活变得简单,帮助各种 IDE 轻松路由命令
YAML 支持单行注释。在模型的帮助下,它的结构在下面得到了澄清 -
# This is single line comment.
评论亮点: YAML 中的评论亮点如下 -
- 代码执行期间会跳过注释块。
- 注释有助于为确定的代码块添加描述。
- 注释不得出现在标量内。
YAML 确实排除了任何摆脱散列图像 (#) 的方法,因此在多行字符串中,将注释与粗字符串值隔离开来的可能性很小。
例子:
#comment 1
- Value line 1
#comment 2
- value line 2
#comment 3
- value line 3
注释 YAML 块的另一种组合方式是Ctrl+Q 。
注意:类似的进步在偶然的情况下是合适的。经常规定使用 Superb Word 处理器来制作YAML文档,因为它受到大多数工作框架的支持,并结合了工程师友好的路由键。