📜  如何阻止 YAML 中的评论?

📅  最后修改于: 2022-05-13 01:56:50.324000             🧑  作者: Mango

如何阻止 YAML 中的评论?

YAML 是适用于所有编程语言的人性化数据序列化标准。它通常用于配置文件和存储或传输数据的应用程序。

在 YAML 中进行注释的正常方式是使用“#”符号进行内联注释,但是,如果您想对块进行注释,那么我们有一个可以完成的方式列表。

第 1 步:选择区块

第 2 步:在 Mac 上按cmd/或在 Linux 和 Windows 上按ctrl/

注意:此方法适用于以下编辑器 -

  • 崇高的文本编辑器
  • 原子编辑器
  • Eclipse(带有 YEdit 插件)
  • JetBrains IDE:RubyMine 和 Gogland
  • 视觉工作室代码

在代码的任何级别,您都可以添加一个名为“描述”或“评论”或“注释”或任何您希望的新块文本

例子:

Instead of
# This comment
# is too long

use
Description: >
This comment
is too long

or
Comment: >
This comment is also too long
and newlines survive from parsing!

好处:

  • 如果注释变得太大、太复杂并且有很多重复模式,您可能希望将它们从纯文本块提升为对象。
  • 您的应用将来可能需要阅读/更新评论。
  • 这种方法非常方便,特别是如果有人希望这些注释出现在 JSON 或 XML 中,如果要从 YAML 转换为这两个。