0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

怎样在YAML中添加注释

CHANBAEK 来源:TIAP 作者:TIAP 2023-01-30 16:02 次阅读

AML 广泛用于为容器化应用程序编写配置文件。 解释特定行或者忽略错误行,都需要用到注释。

YAML 仅支持单行注释,即在注释文本前使用 #,# 后面的字符均为注释的内容。

# This is a single line comment
foo: bar # This is an inline comment

不能像在 C 或者 C++ 那样使用注释块。 然而,在某些文本编辑器中,可以使用快捷键注释掉多行。

我们先来看一下单行注释。

在 YAML 中注释单行

在 YAML 中添加单行注释,使用井号 #。 看下面的例子:

图片

注释不一定放在一行的开头,在中间也是可以的,需要注意的是,井号 # 往后的部分,都会被标记为注释:

foo: bar
     windows: discard # Inline comment 
     linux:
       debian: ubuntu
       arch: manjaro

YAML 中的多行注释(使用 nano)

在 C 和许多其他语言中,可以使用 /* */ 来注释掉整块代码。 但是在 YAML 中并没有这样的功能。 如果你要注释掉 20 行代码,那需要在这 20 行代码的开头都添加 # 。

添加多行注释,可以手动一个一个的添加 #,也可以使用专门的文本编辑器,使用快捷键来将 # 添加到需要注释的行。

作为演示,我们使用 nano 编辑器。 遵循 4 个简单的步骤就可以注释多行。

1)使用 Alt + A 设置标记

要在nano文本编辑器中选择行,首先,您必须设置一个标记,指示要开始选择的位置:

图片

一旦按下 Alt+A,nano 将指示你在该行上做了标记。

2)使用上下箭头按键选择要注释的行

做完标记后,可以使用向上或向下的箭头按键来选择多行:

图片

3)使用 Esc + 3 注释所选行

选择好需要注释的行后,按键 Esc + 3 将所选行注释掉:

图片

4)取消标记

注释掉所选行后,还需要取消设置的标记,依然使用 Alt + A 组合键。

图片

最后,可根据具体任务保存更改(或者保存后退出 nano 文本编辑器)。

如果你使用的编辑器不是 nano,也是可以的,其操作大同小异。 大多数文本编辑器都具有多行注释的功能。

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • C++
    C++
    +关注

    关注

    21

    文章

    2066

    浏览量

    72903
  • 代码
    +关注

    关注

    30

    文章

    4557

    浏览量

    66845
  • 编辑器
    +关注

    关注

    1

    文章

    788

    浏览量

    30257
  • 注释
    +关注

    关注

    0

    文章

    11

    浏览量

    6497
  • AML
    AML
    +关注

    关注

    0

    文章

    8

    浏览量

    7325
收藏 人收藏

    评论

    相关推荐

    51程序(为了大家学习,所以没加注释

    51程序,为了大家学习研究,所以没加注释
    发表于 07-28 10:06

    无法keil 3显示中文注释!求指教!

    keil 3 无法添加中文注释利用\\和\* 注释都无法显示中文,尽出现空格!麻烦知道的友友告诉偶一声!谢谢!
    发表于 10-04 11:04

    无法keil 3显示中文注释!求指教!

    keil 3 无法添加中文注释利用\\和\* 注释都无法显示中文,尽出现空格!麻烦知道的友友告诉偶一声!谢谢!
    发表于 10-04 15:50

    无法keil 3显示中文注释!求指教!

    keil 3 无法添加中文注释利用\\和\* 注释都无法显示中文,尽出现空格!麻烦知道的友友告诉偶一声!谢谢!输入中文后就直接显示空格!
    发表于 10-04 20:39

    AD10 原理图上 文字注释丢失!!!!

    `请教各位高手:我使用AD10画原理图时候,使用frame添加注释,保存之后关闭原理图,再次打开注释的后半部分文字会丢失。这是什么原因造成的啊!`
    发表于 05-08 21:34

    怎么labview的while循环上加注释

    怎么labview的while循环上加注释
    发表于 06-08 16:11

    labview XY图如何实现给多条曲线添加注释

    请教,如何实现为XY图形的多条曲线同时添加注释?这个功能labview能实现么,谢谢!
    发表于 09-12 18:14

    labview导出VI字符串,可以加注释什么的吗?我要申请软著

    labview导出VI字符串,可以加注释什么的吗?我要申请软著,源代码行数不太够、、、可以加些什么啊、
    发表于 10-10 09:45

    详解ABBYY PDF Transformer+添加注释

    很多人喜欢书本文章关键位置加上自己的想法、理解等文字注释,普通的PDF软件不能满足你这样的要求,而ABBYY PDF Transformer+可让您在PDF页面的任何地方添加注释,使之更有
    发表于 09-22 16:42

    怎么保存的文件添加用户定义的注释

    有没有办法将用户定义的注释添加到保存的文件(sNp,csa,ect ...)? 以上来自于谷歌翻译 以下为原文Is there a way to add user defined comments to the saved files (sNp, csa, ect...
    发表于 02-14 15:08

    请问LabView的程序框图的注释怎么添加

    请问怎样LabView的程序框图添加注释.
    发表于 03-27 02:53

    DBeaver添加汉字注释出现乱码问题的解决办法?

    DBeaver添加汉字注释后,选择另存为后,注释的汉字出现乱码问题的解决办法是什么?
    发表于 11-05 07:01

    如何将udev规则和/或netplan config.yaml文件添加到Ubuntu devel rfs?

    ,或者我们是否需要按照“如何在 Flexbuid 添加新的应用程序组件”来将文件复制到适当的位置,例如 /etc/netplan ?
    发表于 03-24 07:15

    如何在代码中添加注释

    什么是代码注释,如何在代码中添加注释,相信每一位了解编程的人并不陌生。注释里往往有很多有趣的脑洞和「真心话」
    的头像 发表于 10-17 10:53 1w次阅读

    YAML是什么?

    YAML **不是标记语言** ”(缩写为 YAML)是一种 **数据序列化语言** ,旨在 **对人类友好** ,并且可以与现代**编程语言**很好地配合完成常见的 **日常任务** 。
    的头像 发表于 02-15 09:53 1169次阅读